跳转至

错误响应与状态码

统一响应包装

成功

{
  "code": 1,
  "message": "success",
  "data": {}
}

失败

{
  "code": 0,
  "message": "error detail"
}

200 OK

表示请求已成功处理。

{
  "code": 1,
  "message": "success",
  "data": {
    "items": []
  }
}

400 Bad Request

适用于:

  • 缺少必填参数
  • 参数类型错误
  • 枚举值不支持
  • 分页、频率、排序等参数超出限制
{
  "code": 0,
  "message": "missing or invalid params"
}

401 Unauthorized

适用于:

  • 未传 Token
  • Token 无效
  • 时间戳超时
  • Nonce 重放
  • 签名不匹配
{
  "code": 0,
  "message": "unauthorized"
}

403 Forbidden

适用于:

  • Token 过期
  • Token 被禁用
  • 已启用 scope,当前 scope 不足
{
  "code": 0,
  "message": "forbidden"
}

404 Not Found

适用于:

  • 资源不存在
  • 查询结果为空且接口采用 404 语义
  • 路由不存在
{
  "code": 0,
  "message": "not found"
}