接口模板

XXX接口文档
编写人 xxx，时间2018-12-29
URL环境
测试环境http://xxxx
正式环境https://xxxx
1 post请求
URL: xxx/fire-login/api/account/mobilelogin
HTTP请求方式
POST
请求参数 （json格式的数据，raw形式发送）
参数 必选 类型 说明
自定义 false object 数据实例

参数示例
http://xxx
{
“name” : “测试3”
}

返回字段
参数 必选 类型 说明
code true int 错误码（附录1）
message true String 错误描述
data false object 数据,可为空
data参数数据
参数 必选 类型 说明
自定义 false object 数据实例

返回示例

{
“code”: 200,
“data”: “”,
“message”: “Success”
}

1 get请求
URL: xxx/
HTTP请求方式
get
请求参数
参数 必选 类型 说明
自定义 false object 数据实例

参数示例
http://192.168.3.110/api/account/mobilelogin?key=value

返回字段
参数 必选 类型 说明
code true int 错误码（附录1）
message true String 错误描述
data false String 数据,可为空
data参数数据
参数 必选 类型 说明
自定义 false object 数据实例

返回示例

{
“code”: 1,
" message ": “登陆成功”,
" data ": object
}

附录1
错误码
错误码 类型 说明
1 Int 成功
自定义 Int 根据业务逻辑自定义