Appearance
API 响应规范
统一包装 ApiResponse
json
{
"code": 0,
"message": "成功",
"data": { ... }
}| code | HTTP | 含义 |
|---|---|---|
| 0 | 200 | 成功 |
| 401 | 401 | 未登录或 Token 无效 |
| 403 | 403 | 无权限 |
| 404 | 404 | 资源不存在 |
| 422 | 422 | 参数或业务校验失败 |
分页 PageResult
json
{
"code": 0,
"message": "成功",
"data": {
"list": [...],
"total": 100,
"page": 1,
"pageSize": 10
}
}中文错误信息(双后端对齐)
| 场景 | message |
|---|---|
| 未登录 | 未登录或登录已失效 |
| 无权限 | 没有访问权限 |
| 用户禁用 | 用户已禁用 |
| 登录失败 | 用户名或密码错误 |
| 原密码错误 | 原密码错误 |
前端处理
@xichen-full-stack/api-client 将非 0 的 code 转为 ApiError 抛出,页面用 isApiError(error) 取 message 展示。