您的位置：360文档中心› 开发接口文档-API文档模板

开发接口文档-API文档模板

合集下载

开发接口文档-API文档模板

开发接口文档-API文档模板

code messageXXX项目接口文档1获取所有字段1.1获取所有宇段请求地址:/session/field/findAII响应10000成功f -1系统错误，10001必填参数为空响应描述如响应例子请求例子:http://127.0.0.1:8080/session/field/findAII?name=X 响应例子：{\ode H:-10000M f M exception":null f M isSuccess-:true/,message rt：-^ f系统处理正常！"/page":0/pageSize":0/returnObject":null/retumValue•:{"types^null/villages^null/companys^H^conC olour 丫Ticon SizelOJconStyle•:•丁icT:4「name 丫XXXiconColour 丫TiconSizelO/iconStyle•: ■:・icT:5/ nameTXX”},{”iconColourTTiconSize・：（TiconStyle”：・Ticr：7「name・：-X X”}]}「totals・：0}2文件上传2.1文件上传（ajax）请求地址:/session/file/upload 请求参数formData.append("file M f this.files[O]);$.ajax({url: routePath + "/session/file/upload"ftype : TOST；data : formData,processData : false,contentType : false, success : function (result) {result = JSON.parse(result);if(result.code== -10000M){layer.msg(上传成功！ *);$(M#editHeadPortrait M).val(result.returnValue.filePath);}}});响应例子：returnValue 里包含了fileName 和filePath3字段管理•所属类型3.1新熠所属类型请求地址:/session/fieldType/save响应响应例子：{"code^^lOOOO'/'exception^null/isSuccess^true/'message*:*^^ ,系统处理正箒! "/page^O/pageSize^O/returnListSize^O/returnObject^null/returnValue^null/totals^O}3.2修改所属类型请求地址:/session/fieldType/update 请求参数响应请求例子：http://127.0.0.1:8080/session/fieldType/update?id=2&name二test响应例子：{"code^/lOOOO^'exception^null/isSuccess^true/'message^/fiE% f系统处理正常！•/page":0/pageSize":0/returnListSize B:0/retumObject":null/returnValue R:null r"totals":0}3.3根据id获取所属类型请求: /session/fieldType/getByld 请求参数响应例子：{"code^/lOOOO'/'exception^null/isSuccess^true/^message'/fiJ^t) f 系统处理正常！ "/page H :0/pageSize ,,:0/returnListSize":0/returnObject M :null/returnValue"：rid e :2/',name":,,re -}f H totals ,,:0}3.4获取所属类型列表请求: /session/fieldType/selectAII请数请求例子：http://127.0.0.1:8080/session/fieldType/selectAII?name=l 响应例子：{"code^/lOOOO'/'exception^null/isSuccess^true/'message^'sJ^J f 系统处理正箒! ；-page":0/pageSize":0/returnObject R :null/returnValue\[rid":l ；name\"123"}X"id\6r w name"：-145555"}] /totals":2}3.5删除所属类型（批星）请求地址:/session/fieldType/deleteBylds 请求参数响应例子：{"code^/lOOOO'/'exception^null/isSuccess^true/'message'/fiJ^i] f 系统处理正常！ "/page^O/pageSize^O/retumListSize^O/returnObject^null/returnValue^null/totals^O}。

api设计文档示例

api设计文档示例

api设计文档示例以下是一个api设计文档的示例：API名称：获取用户信息API地址：/api/user/{userID}请求方式：GET请求参数：- userID: 必选，用户ID，数字类型，例如：123响应参数：- code: 状态码，数字类型，例如：200表示成功，400表示请求参数错误，500表示服务器内部错误等- message: 状态信息，字符串类型，例如：请求成功，请求参数错误，服务器内部错误等- data: 用户信息，json类型，例如："userID": 123,"userName": "张三","age": 20,"gender": "男"}错误码：- 400 - 请求参数错误- 404 - 用户不存在- 500 - 服务器内部错误请求示例：GET /api/user/123 HTTP/1.1 Host:响应示例：HTTP/1.1 200 OKContent-Type: application/json;charset=utf-8{"code": 200,"message": "请求成功","data": {"userID": 123,"userName": "张三","age": 20,"gender": "男"}}。

API文档模版-Markdown

API文档模版-Markdown

API⽂档模版-Markdown## ⽤户信息接⼝列表---#### 读取接⼝| | ||:-------------:|:-------------|| [users/mobile](#users-mobile) | 获取⽤户⼿机号 |#### 写⼊接⼝| | ||:-------------:|:-------------|| [users/mobile/put](#users-mobile-put) | 上传⽤户⼿机号 | ## ⽤户信息接⼝详情* #### users/mobile---获取⽤户⼿机号##### 是否需要权限验证---是##### 请求参数---| | 必选 | 类型 | 说明 ||:-------------:|:-------------|:-------------|| userId | true | int | ⽤户ID |##### 请求⽅法---GET##### 调⽤样例---` ``users/mobile?userId=214 ` ``##### 返回结果---*** JSON⽰例 ***` ``{"code": 0,"msg": "","data": { "mobile": 150888888888 }}` ``*** 错误返回值 ***| code | msg | 说明 ||:-------------:|:-------------|| 1010 | xxxx | xxxx |关于其它错误返回值与错误代码，参见 [错误代码说明] (#errorcode)## ErrorCode### 错误代码对照表---##### 系统级错误---| 错误代码 | 返回msg | 详细描述 ||:-------------:|:-------------|| 400 | 系统错误，请稍候再试 | 请求参数有误 || 401 | 系统错误，请稍候再试 | ⽤户未登录 || 404 | 系统错误，请稍候再试 | 资源未找到 || 405 | 系统错误，请稍候再试 | 请求⽅法不⽀持 || 500 | 系统错误，请稍候再试 | 服务器错误 |##### 业务级错误---| 错误代码 | 详细描述 ||:-------------:|:-------------|| 1010 | xxxx |效果如下：⽤户信息接⼝列表读取接⼝users/mobile获取⽤户⼿机号写⼊接⼝users/mobile/put上传⽤户⼿机号⽤户信息接⼝详情users/mobile获取⽤户⼿机号是否需要权限验证是请求参数必选类型说明userId true int⽤户ID请求⽅法GET调⽤样例` `` users/mobile?userId=214 ` ``返回结果JSON⽰例` ``{"code": 0,"msg": "","data": {"mobile": 150888888888}}` ``错误返回值code msg说明1010xxxx xxxxcode msg说明关于其它错误返回值与错误代码，参见错误代码说明ErrorCode错误代码对照表系统级错误错误代码返回msg详细描述400系统错误，请稍候再试请求参数有误401系统错误，请稍候再试⽤户未登录404系统错误，请稍候再试资源未找到405系统错误，请稍候再试请求⽅法不⽀持500系统错误，请稍候再试服务器错误业务级错误错误代码详细描述1010xxxx。

完整word版,API参考指南模板1.0

完整word版,API参考指南模板1.0
该接口用于实现一些功能。
3.1.2请求URL
GET /api/endpoint1
3.1.3请求参数
参数名
类型
必填
描述
param1
string
是
参数1
param2
int
否
参数2
3.1.4响应参数
参数名
类型
描述
result
int
结果
message
string
返回信息
3.1.5响应示例
{
"result": 0,
"message": "成功"
}
3.2接口2
3.2.1接口描述
该接口用于实现另外一些功能ndpoint2
3.2.3请求参数
参数名
类型
必填
描述
param1
string
是
参数1
param2
int
否
参数2
3.2.4响应参数
参数名
类型
描述
result
int
结果
message
string
返回信息
3.2.5响应示例
{
"result": 0,
"message": "成功"
}
4.参考
完整word版,API参考指南模板1.0
完整word版API参考指南模板1.0.0
1.简介
本文档是API参考指南的模板，用于规范并说明API的使用方法和参数，方便开发人员快速了解和使用API接口。
2.版本控制
版本号
日期
作者
说明

简洁的接口文档模板

简洁的接口文档模板

简洁的接口文档模板
1.接口概述
在这一部分，简要描述接口的作用、功能和目标。

2.接口说明
在这一部分，详细说明接口的参数、返回值、请求方式等。

2.1请求URL
描述接口的具体请求地址。

2.2请求方法
描述接口的请求方式，如GET、POST等。

2.3请求参数
列出接口的请求参数，包括参数名、类型、是否必填以及说明。

2.4响应
描述接口的响应结果，包括返回值类型、示例值以及说明。

3.接口示例
在这一部分，给出接口的示例请求和响应。

3.1请求示例
给出一个接口请求的示例，包括请求方法、URL和参数。

3.2响应示例
给出一个接口响应的示例，包括响应的状态码和返回结果。

4.错误码
在这一部分，列出接口可能返回的错误码和对应的错误信息。

5.版本记录
在这一部分，记录接口的版本更新历史。

5.1版本号
记录每个版本的版本号。

5.2变更内容
描述每个版本的新增、修改和移除的接口。

6.参考资料
在这一部分，列出接口设计过程中参考的资料和文档。

以上是一个简洁的接口文档模板。

通过这个模板，可以清晰明了地描
述接口的功能、参数、返回值以及示例，方便开发人员理解和使用接口。

同时，在错误码和版本记录部分，能够追踪和管理接口的错误和变更情况，保证接口的稳定性和可维护性。

开发接口文档API文档模板

开发接口文档API文档模板

开发接口文档API文档模板接口文档（API文档）是用于描述如何与软件系统的接口进行交互的一种文档。

它通常包括接口的定义、输入参数、输出结果、错误码等信息，帮助开发人员理解如何使用接口。

下面是一个常见的API文档模板，用于开发接口文档：##接口名称接口名称##接口描述接口的简要描述，包括接口的作用、使用场景等。

##接口地址接口的URL地址，包括协议、主机名、路径等。

##请求方法接口的请求方法，如GET、POST、PUT、DELETE等。

##输入参数接口的输入参数列表，包括参数名、类型、是否必需等信息。

例如：参数名，类型，是否必需，描述------，----，--------，----参数1，类型，是，描述参数2，类型，否，描述##输出结果接口的输出结果，包括返回结果的数据结构、字段描述等。

例如：```"code": 200,"message": "Success","data":"field1": "value1","field2": "value2"}```##错误码接口可能返回的错误码列表，包括错误码、错误描述等信息。

例如：错误码，错误描述------，------------ERRCODE1，错误描述1ERRCODE2，错误描述2##示例接口的使用示例，包括请求参数、返回结果等。

例如：###请求示例```"param1": "value1","param2": "value2"```###返回示例```"code": 200,"message": "Success","data":"field1": "value1","field2": "value2"}```##版本历史接口的版本历史，包括每个版本的变更记录、发布日期等。

公司接口API文档规范模板

公司接口API文档规范模板
Xxx系统
接口文档
海南科澜科技有限公司
二零二零年叁月
修订记录
日期
版本
说明
作者
获取用户信息接口
接口名称
getuserinfo
http请求方式
GET
访问的URL
http://127.0.0.1:8002/mobileserver/getuserinfo
功能
1.获取用户信息
说明
1.获取用户信息
请求参数
参数
"idType":2
}
}
返回示例
{"code":"0"," retMsg":"成功"}
参数说明
参数类型
是否是必填
备注
user
id
用户id
int(12)
Y
用户ID
username
用户名
String(20)
Y
用户名称
password
密码
String(20)
N
age
年龄
int(5)
N
birthday
出生日期
datetime
N
idType
证件类型
int(2)
Y
1:身份证
2：护照
3：军官证
ห้องสมุดไป่ตู้4：其他
返回信息
code
返回代码
0:成功。其他：失败
retMsg
返回信息
成功返回“成功”，其他返回对应的错误信息
参数示例
请求示例
{
"user":{
"id":1,

API接口说明书模板

API接口说明书模板

API接口说明书Word模板API接口说明书某某系统接口说明书北京某某科技有限公司2020年7月目录某某系统接口说明书1引言1.1编写目的1.2范围1.3参考资料2APP接口说明2.1接口名称2.1.1请求地址2.1.2参数说明2.1.3返回结果说明2.1.4示例1引言1.1编写目的本报告的目的为了明确某某艺术馆App调用系统服务器的接口，为安排App的开发提供依据。

1.2范围本报告主要围绕App应用提出的基本需求，为下一步的App开发系统提供基础的API接口。

2APP接口说明2.1接口名称2.1.1请求地址2.1.3返回结果说明2.1.4示例URL：http://www.***.com/d/app/focusAd?type=1&locale=zh 返回结果：[{"id":18,"picUrl":"focusad/08f5c8d1-7671-4514-cfc0-7a76e4e64836.jpg","title":"独立风骨","type":1,"createtime":1434532509000,"effTs":14345325 09000,"des":"","isUsing":1,"sortNum":1,"toUrl":"http://w ww.***.com/guest/88242"},{"id":16,"picUrl":"focusad/fd e16538-50f1-48f6-ef14-b17c78772fa1.jpg","title":"华南理工大学","type":1,"createtime":1433154304000,"effTs":14331543 04000,"des":"舞跃华南","isUsing":1,"sortNum":1,"toUrl":"http://www.***com/c ontent/expoEvent16/1"},{"id":19,"picUrl":"focusad/b1782a75-429f-476f-cc75-8c3601e85ddb.jpg","title":"中央美术学院"}]。

  1. 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
  2. 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
  3. 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。

XXX项目接口文档
版本控制信息
1获取所有字段
1.1获取所有字段
请求地址：/session/field/findAll
响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正常！
","page":0,"pageSize":0,"returnObject":null,"returnValue":{"types":null,"villages":null,"companys":[{"iconColour":"", "iconSize":0,"iconStyle":"","id":4,"name":"XX"},{"iconColour":"","iconSize":0,"iconStyle":"","id":5,"name":"XX"},{"icon Colour":"","iconSize":0,"iconStyle":"","id":7,"name":"XX"}]},"totals":0}
2文件上传
2.1文件上传（ajax）
请求地址：/session/file/upload
formData.append("file", this.files[0]);
$.ajax({
url : routePath + "/session/file/upload",
type : 'POST',
data : formData,
processData : false,
contentType : false,
success : function(result) {
result = JSON.parse(result);
if(result.code == "10000"){
layer.msg('上传成功！');
$("#editHeadPortrait").val(result.returnValue.filePath);
}
}
});
响应例子：returnValue里包含了 fileName和filePath
3字段管理-所属类型
3.1新增所属类型
请求地址：/session/fieldType/save
响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"totals":0}
3.2修改所属类型
请求地址：/session/fieldType/update
响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"totals":0}
3.3根据id获取所属类型
请求地址：/session/fieldType/getById
响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":{"id":2,"name":"re"},"totals":0}
3.4获取所属类型列表
请求地址：/session/fieldType/selectAll
响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正常！","page":0,"pageSize":0,"returnObject":null,"returnValue":[{"id":1,"name":"123"},{"id":6,"name":"145555"}],"totals": 2}
3.5删除所属类型（批量）
请求地址：/session/fieldType/deleteByIds
响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"totals":0}。

相关文档
最新文档