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?

Introduction

Next簡介

Last updated 5 years ago

Was this helpful?

簡介

這份指南講述出自於 的 HTTP + JSON API 設計方式,原本的點子來自 等人的 。

除了提到 API 本身之外,也介紹了 Heroku 內部 API,希望 Heroku 以外的 API 設計者也會感到興趣。

我們的目標是一致性並專注在商務邏輯,避免被瑣事耽擱。尋求的雖未必是 API 設計的終極之道,但卻是健全、一致,且有完整文件的方法。

我們假設您已熟悉基本的 HTTP + JSON API,因此本指南不會涵蓋所有的基本知識。

歡迎一同為這份指南,本書的。

版本

  • 15.02.0

    • 新增章節: 基礎/少些顧慮

    • 潤飾部分章節文句

    • 對應 (232f8dc)

  • 14.12.0

    • 初版,對應 (c3a69b5)

Heroku Platform API
Wesley Beary
HTTP API Design Guide
貢獻心力
貢獻者見此
版本
版本