统一请求响应
响应Json基本结构
{
"code": 1,
"message": "success",
"data": ...,
"timestamp": 1629610503506,
"executeTime": 1
}
| 参数 | 类型 | 值 |
|---|---|---|
| code | int | 状态码 |
| message | string | 状态说明 |
| data | - | 返回的数据内容 |
| timestamp | long | 服务器时间 |
| executeTime | int | 执行所花时间 |
统一状态码
目前内置了五种通用状态码,分别为 执行成功(1),参数验证失败(0),以及系统异常(-1),access_token认证失败(401),无效请求地址(404)
| 状态码 | 信息 | 解释 |
|---|---|---|
| -1 | 系统内部出现错误 | 接口实现逻辑异常,联系客服 |
| -1 | 【fill xxx】 | 系统异常,联系客服 |
| 0 | xxx参数必填 | 有部分参数未填,参照接口文档修改 |
| 1 | success | 执行成功 |
| 401 | 令牌不可用 | 令牌过期/被覆盖/填写错误,检查或重新获取 |
| 404 | Not Found | 接口地址填写错误或系统异常 |
- 另外,在接口定义的请求地址之外,完全未预料的情况下,可能会返回:
{ "timestamp": "YYYY-MM-DD HH:mm:ss", "status": 404, "error": "Not Found", "message": "", "path": "/xxxxxx/xxx/xxx" }
其他针对接口的特殊状态码,在各自接口文档中体现