🌐 API状态码设计
帮助设计规范的API响应状态码体系,生成统一响应格式
📐 统一响应格式
{
"code": 0,
"message": "success",
"data": { ... }
}
📊 状态码定义
| 业务码 | HTTP状态 | 描述 | 说明 |
|---|
💡 最佳实践
✅ 业务码与HTTP码分离
HTTP状态码表示传输层状态,业务码表示业务逻辑状态。code: 0 表示业务成功,非0表示业务错误。
✅ 业务码分段管理
按模块分段:1xxxx用户模块、2xxxx订单模块、3xxxx支付模块等,便于定位问题。
✅ 错误信息国际化
message字段返回用户可读信息,code用于程序判断。前端根据code做国际化映射。
✅ 分页响应格式
列表接口返回 {list, total, page, pageSize},便于前端分页组件使用。
✅ 错误详情字段
验证错误时增加 errors 字段,返回每个字段的错误信息:{field: "email", message: "格式不正确"}
✅ 请求ID追踪
响应中包含 requestId 字段,便于日志追踪和问题排查。
👁️ 预览