天天看點

RESTful API規範詳解

restful其實就是一套編寫接口的協定,協定規定如何編寫以及如何設定傳回值、狀态碼等資訊。

RESTful API就是REST風格的API。

那麼在什麼場景下使用RESTful API呢?

在當今的網際網路應用的前端展示媒介很豐富。有手機、有平闆電腦還有PC以及其他的展示媒介。那麼這些前端接收到的使用者請求統一由一個背景來處理并傳回給不同的前端肯定是最科學和最經濟的方式,RESTful API就是一套協定來規範多種形式的前端和同一個背景的互動方式。

RESTful API由背景也就是SERVER(伺服器)來提供前端來調用。前端調用API向背景發起HTTP請求,背景響應請求将處理結果回報給前端。也就是說RESTful 是典型的基于HTTP的協定。那麼RESTful API有哪些設計原則和規範呢?

1,資源:首先是弄清楚資源的概念。資源就是網絡上的一個實體,一段文本,一張圖檔或者一首歌曲。資源總是要通過一種載體來反應它的内容。文本可以用TXT,也可以用HTML或者XML、圖檔可以用JPG格式或者PNG格式,JSON是現在最常用的資源表現形式。

2,統一接口:RESTful風格的資料元操CRUD(create,read,update,delete)分别對應HTTP方法:

GET用來擷取資源,

POST用來建立資源(也可以用于更新資源),

PUT用來更新資源,

DELETE用來删除資源,

這樣就統一了資料操作的接口。

3,URI:可以用一個URI(統一資源定位符)指向資源,即每個URI都對應一個特定的資源。要擷取這個資源通路它的URI就可以,是以URI就成了每一個資源的位址或識别符。一般的,每個資源至少有一個URI與之對應,最典型的URI就是URL。

4,無狀态:所謂無狀态即所有的資源都可以URI定位,而且這個定位與其他資源無關,也不會因為其他資源的變化而變化。有狀态和無狀态的差別,舉個例子說明一下,例如要查詢員工工資的步驟為第一步:登入系統。第二步:進入查詢工資的頁面。第三步:搜尋該員工。第四步:點選姓名檢視工資。這樣的操作流程就是有狀态的,查詢工資的每一個步驟都依賴于前一個步驟,隻要前置操作不成功,後續操作就無法執行。如果輸入一個URL就可以得到指定員工的工資,則這種情況就是無狀态的,因為擷取工資不依賴于其他資源或狀态,且這種情況下,員工工資是一個資源,由一個URL與之對應可以通過HTTP中的GET方法得到資源,這就是典型的RESTful風格。

說了這麼多,到底RESTful長什麼樣子的呢?

GET:h ttp://www.xxx.com/source/id 擷取指定ID的某一類資源。

例如GET:h ttp://www.xxx.com/friends/123表示擷取ID為123的會員的好友清單。如果不加id就表示擷取所有會員的好友清單。

POST:h ttp://www.xxx.com/friends/123表示為指定ID為123的會員新增好友。

其他的操作類似就不舉例了。

轉載

原文出處:https://blog.csdn.net/hjc1984117/article/details/77334616

繼續閱讀