为什么要统一响应格式?
❌ 问题:不同接口返回格式不一致
// 接口 A
{ "data": { "user": {...} } }
// 接口 B
{ "result": { "user": {...} } }
// 接口 C
{ "user": {...} }
前端需要针对每个接口单独处理,代码冗余,容易出错
✅ 解决:统一响应格式
{
"code": 0,
"message": "success",
"data": { ... },
"request_id": "req-xxx"
}
响应字段说明
{{ field.name }}
{{ field.type }}
必填
{{ field.desc }}
业务状态码设计
0
成功
1xxxx
客户端错误
2xxxx
业务错误
3xxxx
认证/权限错误
5xxxx
系统错误
{{ code.code }}
{{ code.message }}
不同场景响应示例
{{ currentExample.code }}
{{ currentExample.note }}
分页参数设计
请求参数
page
页码,从 1 开始
page_size
每页数量,默认 20
sort
排序,如 created_desc
响应格式
"pagination": {
"page": 1,
"page_size": 20,
"total": 156,
"total_pages": 8,
"has_next": true
}