1、協議

盡量使用 HTTPS

2、’域名

盡量將API部署在專用域名之下

如果API很簡單，不會有進一步擴展，可以考慮放在主域名下

3、版本

應該將版本放在URL中 ，例如 https://api.xxx.com/v1

4、路徑

每個網址，就是一種資源，所以不能有動詞，只能有名詞

5、HTTP動詞

對於資源的具體操作類型，由http動詞表示

常用的有5個

GET,POST,PUT,PATCH,DELETE

HEAD 獲取資源元數據

OPTIONS 獲取信息，關於資源哪些屬性是客戶端可以改變的

6、過濾信息

如果記錄數量很多，服務器不可能都將它們返回給用戶。API應該提供參數，過濾返回結果

limit offset page per_page

7、狀態碼

8、錯誤處理

如果狀態 4xx ，就應該想用戶返回出錯信息。一般來說，返回的信息中獎error作為鍵名

9、返回結果

• GET /collection：返回資源對象的列表（數組）
• GET /collection/resource：返回單個資源對象
• POST /collection：返回新生成的資源對象
• PUT /collection/resource：返回完整的資源對象
• PATCH /collection/resource：返回完整的資源對象
• DELETE /collection/resource：返回一個空文檔

10、Hypermedia API

11、其他

身份認證，應該使用 oauth2.0

返回數據格式，盡量使用 JSON

RESTful API 如何設計