Skip to content
ADP
API Design PrincipleBETA

[ADP-402] 空白問題類型

根據 https://www.rfc-editor.org/rfc/rfc7807#section-4.2,如果你不需要額外資訊來擴展原始的 HTTP 狀態碼,你可以使用 about:blank

指導原則

  • 如果你不需要額外資訊來擴展原始的 HTTP 狀態碼,可(MAY)使用 about:blank
  • 你可以(MAY)指定類型為狀態碼對應的文字,即使你不打算將問題類型發佈到公網網路。

範例

以下兩個方式都合規:

http
HTTP/1.1 404 Not Found
Content-Type: application/problem+json
Content-Language: en
{
  "type": "about:blank",
  "title": "Not found",
  "status": 404,
  "detail": "在此伺服器上找不到請求的資源。"
}
http
HTTP/1.1 404 Not Found
Content-Type: application/problem+json
Content-Language: en
{
  "type": "problems/not-found",
  "title": "Not found",
  "status": 404,
  "detail": "在此伺服器上找不到請求的資源。"
}