GitHub 的 Restful HTTP API 設計分解

劍塵發表於2018-09-19
  1. HTTPS
    HTTPS 為介面的安全提供了保障,可以有效防止通訊被竊聽和篡改。
  2. 域名
    應當儘可能的將 API 與其主域名區分開,可以使用專用的域名,訪問我們的 API,例如:
    https://api.larabbs.com
    或者可以放在主域名下,例如:
    https://www.larabbs.com/api
  3. 版本控制
    通常情況下,有兩種做法:
  4. URL統一定位資源
  5. 用HTTP動詞描述動作
  6. 資源過濾
  7. 正確使用狀態碼
  8. 資料響應格式
  9. 呼叫頻率限制
  10. 編寫文件
本作品採用《CC 協議》,轉載必須註明作者和本文連結

相關文章