XXX系统接口文档
文件修改控制
注意: 状态为(C: 新增 U:修改 A:新增 D:删除)
| 编号 |
版本号 |
状态 |
说明 |
变更人 |
修改日期 |
| 1 |
v1.0.0 |
A |
登录接口说明 |
张三 |
2021-03-14 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
接口名称:XX系统登录接口
接口描述
用于用户登录某个系统
接口地址URL
http://127.0.0.1:5000/login/
HTTP请求方式
POST
| 参数名称 |
必选 |
描述 |
备注 |
| User-Agent |
Y |
|
|
|
|
|
|
|
|
|
|
请求参数
| 参数名称 |
类型 |
必选 |
描述 |
备注 |
| username |
string |
Y |
用户名 |
|
| password |
string |
Y |
密码 |
|
| timestamp |
int |
Y |
时间戳 |
必须为13位数的时间戳,且时间戳与服务器误差不能超越10分钟 |
请求示例
{
"username":"张三",
"password":"123456",
"timestamp":"1623044345770"
}
返回值
| 参数名称 |
类型 |
必选 |
描述 |
备注 |
| code |
int |
Y |
状态 |
状态码 |
| msg |
string |
Y |
消息 |
成功:用户登录成功 失败:用户登录失败及失败原因 |
|
|
|
|
|
返回示例
{
"code":100,
"msg":"用户登录成功"
}