http-api-design
  • Introduction
  • Summary
    • 簡介
    • 基礎
      • 重心分離
      • 要求使用安全連線
      • 要求以 Accept 標頭註明版本
      • 以 ETag 支援快取
      • 提供 Request-Id 以便追溯
      • 以 Range 分割資料量大的回應
    • 需求
      • 回傳適當的狀態碼
      • 情況許可時提供全部資源
      • 接受需求本體的序列化 JSON
      • 使用一致的路徑格式
      • 小寫路徑與屬性
      • 支援非 ID 的便利存取
      • 減少巢狀路徑
    • 回應
      • 提供資源的 UUID
      • 提供標準時間戳記
      • 使用 UTC 時間並以 ISO 8601 格式表達
      • 巢狀表示外來鍵關係
      • 產生結構化的錯誤訊息
      • 顯示次數限制狀態
      • 保持所有回應中的 JSON 最小化
    • 產出
      • 提供機器可讀的 JSON 大綱
      • 提供一般人可讀的文件
      • 提供執行範例
      • 描述穩定性
Powered by GitBook
On this page
  • 資源名稱
  • 動作

Was this helpful?

  1. Summary
  2. 需求

使用一致的路徑格式

資源名稱

使用複數版本的資源名稱,除非查詢的資源確定是單數。(舉例而言,多數系統裡使用者只會有一個帳號)。這使你參考其他特定資源時保持行為一致。

動作

存取一般個別資源時,端點毋需特殊的動作。當需採取特殊動作時,將它擺在標準 actions 前綴之後,格式就像:

/resources/:resource/actions/:action

實際例子如:

/runs/{run_id}/actions/stop
Previous接受需求本體的序列化 JSONNext小寫路徑與屬性

Last updated 5 years ago

Was this helpful?