feat: 标准化响应体
This commit is contained in:
33
docs/requirements/0001-Fix-Response-structure.md
Normal file
33
docs/requirements/0001-Fix-Response-structure.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# 标准化响应结构
|
||||
|
||||
1. 需要标准化接口响应的结构,修改后端接口中不符合规范的代码。
|
||||
2. 前端接口类型定义需要与后端接口响应结构保持一致。
|
||||
|
||||
## 响应示例
|
||||
|
||||
- 列表分页响应
|
||||
|
||||
```json
|
||||
{
|
||||
"code": 0, // 响应状态码,0 表示成功,其他值表示失败
|
||||
"message": "success", // 响应消息
|
||||
"data": { // 响应数据
|
||||
"list": [], // 列表数据
|
||||
"page": 1, // 当前页码
|
||||
"pageSize": 10, // 每页显示数量
|
||||
"total": 10 // 总数量
|
||||
},
|
||||
"timestamp": "12346579" // 响应时间戳
|
||||
}
|
||||
```
|
||||
|
||||
- 其他响应
|
||||
|
||||
```json
|
||||
{
|
||||
"code": 0,
|
||||
"message": "success",
|
||||
"data": {},
|
||||
"timestamp": "12346579"
|
||||
}
|
||||
```
|
||||
Reference in New Issue
Block a user