restful api 設計指南——阮一峰一種軟體架構風格、設計風格,而不是標準,只是提供了一組設計原則和約束條件。它主要用於客戶端和伺服器互動類的軟體。基於這個風格設計的軟體可以更簡潔,更有層次,更易於實現快取等機制。
api與使用者的通訊協議,總是使用https協議。
應該盡量將api部署在專用網域名稱之下。
如果確定api很簡單,不會有進一步擴充套件,可以考慮放在主網域名稱下。
應該將api的版本號放入url。
/v1/另一種做法是,將版本號放在http頭資訊中,但不如放入url方便和直觀。github採用這種做法。
路徑又稱"終點"(endpoint),表示api的具體**。
在restful架構中,每個**代表一種資源(resource),所以**中不能有動詞,只能有名詞,而且所用的名詞往往與資料庫的**名對應。一般來說,資料庫中的表都是同種記錄的"集合"(collection),所以api中的名詞也應該使用複數。
舉例來說,有乙個api提供動物園(zoo)的資訊,還包括各種動物和雇員的資訊,則它的路徑應該設計成下面這樣。
/v1/zoos對於資源的具體操作型別,由http動詞表示。/v1/animals
/v1/employees
常用的http動詞有下面五個(括號裡是對應的sql命令)。
get(select):從伺服器取出資源(一項或多項)。還有兩個不常用的http動詞。post(create):在伺服器新建乙個資源。
put(update):在伺服器更新資源(客戶端提供改變後的完整資源)。
patch(update):在伺服器更新資源(客戶端提供改變的屬性)。
delete(delete):從伺服器刪除資源。
head:獲取資源的元資料。下面是一些例子。options:獲取資訊,關於資源的哪些屬性是客戶端可以改變的。
get /zoos:列出所有動物園如果記錄數量很多,伺服器不可能都將它們返回給使用者。api應該提供引數,過濾返回結果。post /zoos:新建乙個動物園
get /zoos/id:獲取某個指定動物園的資訊
put /zoos/id:更新某個指定動物園的資訊(提供該動物園的全部資訊)
patch /zoos/id:更新某個指定動物園的資訊(提供該動物園的部分資訊)
delete /zoos/id:刪除某個動物園
get /zoos/id/animals:列出某個指定動物園的所有動物
delete /zoos/id/animals/id:刪除某個指定動物園的指定動物
下面是一些常見的引數。
?limit=10:指定返回記錄的數量引數的設計允許存在冗餘,即允許api路徑和url引數偶爾有重複。比如,get /zoo/id/animals 與 get /animals?zoo_id=id 的含義是相同的。?offset=10:指定返回記錄的開始位置。
?page=2&per_page=100:指定第幾頁,以及每頁的記錄數。
?sortby=name&order=asc:指定返回結果按照哪個屬性排序,以及排序順序。
?animal_type_id=1:指定篩選條件
伺服器向使用者返回的狀態碼和提示資訊,常見的有以下一些(方括號中是該狀態碼對應的http動詞)。
如果狀態碼是4xx,就應該向使用者返回出錯資訊。一般來說,返回的資訊中將error作為鍵名,出錯資訊作為鍵值即可。
針對不同操作,伺服器向使用者返回的結果應該符合以下規範。
get /collection:返回資源物件的列表(陣列)比如,當使用者向api.example.com的根目錄發出請求,會得到這樣乙個文件。get /collection/resource:返回單個資源物件
post /collection:返回新生成的資源物件
put /collection/resource:返回完整的資源物件
patch /collection/resource:返回完整的資源物件
delete /collection/resource:返回乙個空文件
上面**表示,文件中有乙個link屬性,使用者讀取這個屬性就知道下一步該呼叫什麼api了。rel表示這個api與當前**的關係(collection關係,並給出該collection的**),href表示api的路徑,title表示api的標題,type表示返回型別。
(1)api的身份認證應該使用oauth 2.0框架。
(2)伺服器返回的資料格式,應該盡量使用json,避免使用xml。
什麼是restful風格
傳統的url都是 xx 是什麼都可以猜出來,後來加密之後傳送到後台,然後就出現了所謂的rest,比較流行,但是 有好有壞,用起來靈活的東西 也比較複雜 就像是這個鏈結 最後的數字是它的id或者乙個id的對映,這樣在url裡的資料可以傳到request裡面被後台程式獲取。我理解的restful是 1....
什麼是RESTful風格
http不僅僅是傳輸協議,更是一種應用協議。rest,即representational state transfer的縮寫。意為是 表現層狀態轉化 restful表示一種風格,理解rest前需要理解資源,何謂資源,廣義的資源是指可以操作的所有物件。可能是乙個系統資源,如txt jgp xml 亦可...
什麼RESTful風格API
一 url 設計 1.1 動詞 賓語 restful 的核心思想就是,客戶端發出的資料操作指令都是 動詞 賓語 的結構。比如,get articles這個命令,get是動詞,articles是賓語。動詞通常就是五種 http 方法,對應 crud 操作。get 讀取 read post 新建 cre...