- HTTPS
HTTPS 為介面的安全提供了保障,可以有效防止通訊被竊聽和篡改。 - 域名
應當儘可能的將 API 與其主域名區分開,可以使用專用的域名,訪問我們的 API,例如:
https://api.larabbs.com
或者可以放在主域名下,例如:
https://www.larabbs.com/api - 版本控制
通常情況下,有兩種做法:- 將版本號放入URL中
https://api.larabbs.com/v1
https://api.larabbs.com/v2 - 使用HTTP 請求頭的Accept欄位進行區分
https://api.larabbs.com/
Accept: application/prs.larabbs.v1+json
Accept: application/prs.larabbs.v2+json
- 將版本號放入URL中
- URL統一定位資源
- 用HTTP動詞描述動作
- 資源過濾
- 正確使用狀態碼
- 資料響應格式
- 呼叫頻率限制
- 編寫文件
本作品採用《CC 協議》,轉載必須註明作者和本文連結