鍍金池/ 教程/ Linux/ 生成結構化的錯誤
良好打印的默認 JSON
強制使用安全連接(Secure Connections)
通過請求中的范圍(Range)拆分大的響應
嵌套外鍵關系
支持方便的無 id 間接引用
使用 UTC(世界標準時間)時間,用 ISO8601 進行格式化
提供標準的時間戳
提供資源的(UU)ID
提供全部可用的資源
描述穩(wěn)定性
路徑和屬性要小寫
強制頭信息 Accept 中提供版本號
生成結構化的錯誤
使用統(tǒng)一的資源路徑格式
支持 Etag 緩存
保證響應 JSON 最小化
在請求的 body 體使用 JSON 格式數據
隔離關注點
顯示頻率限制狀態(tài)
提供可執(zhí)行的例子
返回合適的狀態(tài)碼
最小化路徑嵌套
可讀性
為內省而提供 Request-Id

生成結構化的錯誤

響應錯誤的時,生成統(tǒng)一的、結構化的錯誤信息。包含一個機器可讀的錯誤 id,一個人類能識別的錯誤信息(message),根據情況可以添加一個url來告訴客戶端關于這個錯誤的更多信息以及如何去解決它,例如:

HTTP/1.1 429 Too Many Requests
{
  "id":      "rate_limit",
  "message": "Account reached its API rate limit.",
  "url":     "https://docs.service.com/rate-limits"
}

文檔化客戶端可能遇到的錯誤信息格式,以及這些可能的錯誤信息id。