跳到主要内容

API 参考

错误代码

错误代码

MenuGaze API 端点返回标准 HTTP 状态码。错误响应包含一个 JSON 正文,说明出错的详细信息。

错误响应格式

{
  "success": false,
  "error": "Human-readable error message"
}

状态码

代码 含义 常见原因
200 OK 请求成功。响应正文包含所请求的数据。
201 Created 资源创建成功。POST 端点成功时返回。
400 Bad Request 请求体中缺少字段或字段无效。请检查所有必填字段是否都已提供且格式正确。
401 Unauthorized 身份验证令牌缺失或无效。请确保在 Authorization 请求头中包含有效的 Bearer 令牌。令牌可能已过期 — 请重新登录以获取新令牌。
403 Forbidden 您已通过身份验证,但没有访问此资源的权限。这通常意味着您正在尝试访问或修改属于其他餐厅的资源。
404 Not Found 所请求的资源不存在。请确认 URL 路径中的 ID 是否正确。
429 Too Many Requests 超出速率限制。请查看 Retry-After 请求头,了解重试前需要等待的秒数。身份验证端点限制为每个 IP 每 15 分钟 10 次请求。订单创建限制为每个 IP 每分钟 5 次请求。
500 Internal Server Error 服务器发生意外错误。如果问题持续存在,请联系支持团队。这些错误会被自动记录以供调查。
503 Service Unavailable 服务暂时不可用。这可能发生在维护期间,或某个必需的外部服务(例如 worker secret)未配置时。请稍后重试。

速率限制

设有速率限制的端点在超出限制时会返回 429 状态。响应包括:

  • Retry-After 请求头 — 发出下一个请求前需要等待的秒数。
  • 一条说明所超出速率限制的错误消息。

速率限制按 IP 地址应用。当前限制:

端点 限制
登录和注册 每个 IP 每 15 分钟 10 次请求
订单创建 每个 IP 每分钟 5 次请求
相关菜品 每个 IP 每分钟 30 次请求