錯誤對象是特殊化的資源對象,可能在響應中一并返回,用以提供執(zhí)行操作遭遇問題的額外信息。在在JSON API文檔頂層,"errors"對應值即為錯誤對象集合,此時文檔不應該包含其它頂層資源。
錯誤對象可能有以下元素:
"id" - 特定問題的唯一標示符。"href" - 提供特定問題更多細節(jié)的URI。"status" - 適用于這個問題的HTTP狀態(tài)碼,使用字符串表示。"code" - 應用特定的錯誤碼,以字符串表示。"title" - 簡短的,可讀性高的問題總結。除了國際化本地化處理之外,不同場景下,相同的問題,值是不應該變動的。"detail" - 針對該問題的高可讀性解釋。"links" - 可以在請求文檔中取消應用的關聯資源。"path" - 關聯資源中相關屬性的相對路徑。在單資源或單類型資源中出現的問題,這個值才是合適的。額外的元素可以在錯誤對象中指定。
實現接口可以選擇使用其它的errors媒體類型。