一.正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的。一个工整的文档显得是非重要。
接口1 查询排重接口:
接口详情 | ||
---|---|---|
请求地址 | /api/user/login/ | |
请求方式 | GET | |
– | – | – |
参数 | 是否必填 | 说明 |
phone | 是 | 手机号码 |
password | 是 | 密码 |
– | – | – |
返回结果 | 说 明 | |
success | 返回登录状态,true–登录成功,flase–登录失败 | |
msg | 返回登录信息 | |
name | 用户名 | |
sessionId | 返回存入session的标识 | |
– | – | – |
返回结果案例 |
具体返回结果举例:
{
"success": true,
"msg": "登录成功!",
"name": "test",
"sessionId": "6cdf33e6-b037-4ddb-bdce-5158335ffd18",
}
{
"msg": "账号不存在",
"success": false
}
{
"msg": "密码错误",
"success": false
}