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