Restful API設計最佳實踐

2021-09-25 07:41:33 字數 1268 閱讀 7940

restful

rest(representational state transfer),表現層狀態轉移。

表現層是資源的表現層,對於網路中的資源就需要url(uniform resource identifier)來指向

1、協議

使用http或https。對外若有安全性要求,可以使用https,但是內部服務間可以使用http或https。

2、http方法

http請求中的方法表示執行的動作

3、使用名詞

url指向資源,在url路徑的描述中,只要出現名詞,不要出現動詞,動詞由http方法提供

不要單複數混用,建議名詞使用複數

restful的核心是資源,url應該指向資源,所以應該是使用名稱表達,而不是動詞表達。

不要出現下面的訪問資源的路徑

get方法只是獲取資源,而不是改變資源狀態,改變資源需要使用post、put、delete等方法

子資源的訪問

4、集合功能

過濾 filtering

指定過濾條件 get/posts?tag=python

排序 sorting

指定排序條件,有多重風格的設計

分頁 pagination

一般情況下,查詢返回的記錄數很多,必須分頁

5、狀態碼

詳細狀態碼參考

6、錯誤處理

在restful api設計中,錯誤處理也非常重要,單從狀態碼中無法詳盡敘述錯誤的資訊

7、版本

強烈要求使用版本,版本號使用簡單數字

8、返回結果

RESTful API 設計指南 最佳實踐

facebook 谷歌 github netflix 和幾個其他的科技巨頭已經允許開發者和其產品通過 api 呼叫他們的資料,並為他們提供平台。即使你不是寫 api 的專業人士,擁有精美的 api 也對你的應用程式有好處。關於設計 api 的最好方法,網路上有較長一段時間的爭論,但官方也沒有對此給出...

(二)Restful API設計指南 最佳實踐

facebook,google,github,netflix和其他一些科技巨頭給開發人員和產品提供了通過api使用其資料的機會,即使你沒有為其他開發人員和產品編寫過api,對於你的應用程式來說,擁有精心製作的api總是非常健康的。關於設計api的最佳方法,網際網路上存在著長期的爭論,沒有為此定義過任...

RESTful API 最佳實踐

日期 2018年10月 3日 restful 是目前最流行的 api 設計規範,用於 web 資料介面的設計。它的大原則容易把握,但是細節不容易做對。本文總結 restful 的設計細節,介紹如何設計出易於理解和使用的 api restful 的核心思想就是,客戶端發出的資料操作指令都是 動詞 賓語...