返回首页 用 JSON 构建 API 的标准指南
FAQ

Errors

错误对象是特殊化的资源对象,可能在响应中一并返回,用以提供执行操作遭遇问题的额外信息。在在JSON API文档顶层,"errors"对应值即为错误对象集合,此时文档不应该包含其它顶层资源。

错误对象可能有以下元素:

  • "id" - 特定问题的唯一标示符。
  • "href" - 提供特定问题更多细节的URI。
  • "status" - 适用于这个问题的HTTP状态码,使用字符串表示。
  • "code" - 应用特定的错误码,以字符串表示。
  • "title" - 简短的,可读性高的问题总结。除了国际化本地化处理之外,不同场景下,相同的问题,值是不应该变动的。
  • "detail" - 针对该问题的高可读性解释。
  • "links" - 可以在请求文档中取消应用的关联资源。
  • "path" - 关联资源中相关属性的相对路径。在单资源或单类型资源中出现的问题,这个值才是合适的。

额外的元素可以在错误对象中指定。

实现接口可以选择使用其它的errors媒体类型。