API文档说明
2020-01-11 本文已影响0人
someone2017
Host主机名
所有API均只给出Path Url部分，请自行在Url前面附加主机名。
如：
Host：http://localhost:8000
POST /api/v2/users/login
完整API URL为：
POST http://localhost:8000/api/v2/users/login
HTTP状态码
- 200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。
- 201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
- 202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
- 204 NO CONTENT - [DELETE]：用户删除数据成功。
- 400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
- 401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。
- 403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
- 404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
- 406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
- 410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
- 422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
- 500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。
HTTP动词
- GET（SELECT）：从服务器取出资源（一项或多项）。
- POST（CREATE）：在服务器新建一个资源。
- PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。
- PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。
- DELETE（DELETE）：从服务器删除资源。
Token认证
请求头参数
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| Authorization | string | 是 | 访问者token, 格式：bearer_token |
示例
Authorization: Bearer [BEARER_TOKEN]
Token格式：JWT
返回值
返回的JSON数据包（Object）
| 属性 | 类型 | 说明 |
|---|---|---|
| errNo | number | 错误码 |
| errMsg | array | 错误信息 |
| payload | object | array | 返回数据 |
errNo合法值
| 值 | 说明 |
|---|---|
| 0 | 成功 |
