請求
- Content-Type: application/json
- 寫入 JSON 時傳送 Content-Type: application/json。
- data · meta
- 成功回應包含 data 和 meta；集合回應還說明分頁資訊。
- error.code · error.message
- 錯誤包含 error.code、error.message，並在適用時提供欄位資訊。
資料型別
- 必填與允許 null 是獨立概念。
- 如果架構允許，必填欄位可以合法地包含 null。
- 請保留 JSON 布林值、整數、字串和 null 的類型，不要強制轉換。
- 金額以十進位字串表示；不要使用二進位浮點數計算價格。
64-bit · expected_version
- 部分並行控制版本使用有符號 64 位元整數。
- 對於超出 Number.MAX_SAFE_INTEGER 的值，JavaScript 用戶端必須採用無損 JSON 處理，並傳送原始整數表示。
- 不要對版本取近似值，也不要將其轉換為 JSON 字串。
請求標頭與回應標頭
Cache-Control字串選填回應快取策略。
const:"no-store"X-Correlation-ID字串選填用於跟蹤本次 HTTP 請求的識別碼。
WWW-Authenticate字串選填伺服器要求的身份驗證方案。
Allow字串選填此資源支援的 HTTP 方法。
Retry-After整數選填重試前最少等待的秒數。
minimum:0Location字串選填已建立資源的相對 URL。