Skip to content

API 响应规范

统一包装 ApiResponse

json
{
  "code": 0,
  "message": "成功",
  "data": { ... }
}
codeHTTP含义
0200成功
401401未登录或 Token 无效
403403无权限
404404资源不存在
422422参数或业务校验失败

分页 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 展示。

相关文档

Xichen Full Stack 内部文档