restful接口設(shè)計(jì)規(guī)范總結(jié)

khs1994 發(fā)布于2019-08-19 10:14 / 2219人閱讀

摘要：狀態(tài)碼狀態(tài)碼范圍信息，請求收到，繼續(xù)處理。范圍的狀態(tài)碼是保留給服務(wù)器端錯誤用的。當(dāng)收到響應(yīng)時，客戶端不可能知道服務(wù)器的狀態(tài)，所以這類狀態(tài)碼是要盡可能的避免。服務(wù)器向用戶返回的狀態(tài)碼和提示信息，常見的有以下一些方括號中是該狀態(tài)碼對應(yīng)的動詞。

這篇文章主要是借鑒他人，但是自己很想總結(jié)出一套規(guī)范，以供向我這樣的新手使用，用來規(guī)范代碼，如果有什么好的提議，請不吝賜教，本篇文章長期更新！

一、重要概念：

REST,即Representational State Transfer的縮寫。我對這個詞組的翻譯是"表現(xiàn)層狀態(tài)轉(zhuǎn)化"。     Resource（資源） ：對象的單個實(shí)例。 例如，一只動物。它可以是一段文本、一張圖片、一首歌曲、一種服務(wù)，總之就是一個具體的實(shí)在。你可以用一個URI（統(tǒng)一資源定位符）指向它，每種資源對應(yīng)一個特定的URI。要獲取這個資源，訪問它的URI就可以，因此URI就成了每一個資源的地址或獨(dú)一無二的識別符。     
集合：對象的集合。 例如，動物。     
第三方：使用我們接口的開發(fā)者     
表現(xiàn)層（Representation）     
"資源"是一種信息實(shí)體，它可以有多種外在表現(xiàn)形式。我們把"資源"具體呈現(xiàn)出來的形式，叫做它的"表現(xiàn)層"（Representation）。     
狀態(tài)轉(zhuǎn)化（State Transfer）     
訪問一個網(wǎng)站，就代表了客戶端和服務(wù)器的一個互動過程。在這個過程中，勢必涉及到數(shù)據(jù)和狀態(tài)的變化。互聯(lián)網(wǎng)通信協(xié)議HTTP協(xié)議，是一個無狀態(tài)協(xié)議。這意味著，所有的狀態(tài)都保存在服務(wù)器端。因此，如果客戶端想要操作服務(wù)器，必須通過某種手段，讓服務(wù)器端發(fā)生"狀態(tài)轉(zhuǎn)化"（State Transfer）。而這種轉(zhuǎn)化是建立在表現(xiàn)層之上的，所以就是"表現(xiàn)層狀態(tài)轉(zhuǎn)化"。     
客戶端用到的手段，只能是HTTP協(xié)議。具體來說，就是HTTP協(xié)議里面，四個表示操作方式的動詞：GET、POST、PUT、DELETE。它們分別對應(yīng)四種基本操作：GET用來獲取資源，POST用來新建資源（也可以用于更新資源），PUT用來更新資源，DELETE用來刪除資源。     
比如，文本可以用txt格式表現(xiàn)，也可以用HTML格式、XML格式、JSON格式表現(xiàn)，甚至可以采用二進(jìn)制格式；圖片可以用JPG格式表現(xiàn)，也可以用PNG格式表現(xiàn)。     
URI只代表資源的實(shí)體，不代表它的形式。嚴(yán)格地說，有些網(wǎng)址最后的".html"后綴名是不必要的，因?yàn)檫@個后綴名表示格式，屬于"表現(xiàn)層"范疇，而URI應(yīng)該只代表"資源"的位置。它的具體表現(xiàn)形式，應(yīng)該在HTTP請求的頭信息中用Accept和Content-Type字段指定，這兩個字段才是對"表現(xiàn)層"的描述。

綜合上面的解釋，我們總結(jié)一下什么是RESTful架構(gòu)：

　（1）每一個URI代表一種資源；

　（2）客戶端和服務(wù)器之間，傳遞這種資源的某種表現(xiàn)層；

　（3）客戶端通過四個HTTP動詞，對服務(wù)器端資源進(jìn)行操作，實(shí)現(xiàn)"表現(xiàn)層狀態(tài)轉(zhuǎn)化"。

二、REST接口規(guī)范 1、動作

GET （SELECT）：從服務(wù)器檢索特定資源，或資源列表。
POST （CREATE）：在服務(wù)器上創(chuàng)建一個新的資源。
PUT （UPDATE）：更新服務(wù)器上的資源，提供整個資源。
PATCH （UPDATE）：更新服務(wù)器上的資源，僅提供更改的屬性。
DELETE （DELETE）：從服務(wù)器刪除資源。

首先是四個半種動作：
post、delete、put/patch、get
因?yàn)閜ut/patch只能算作一類，所以將patch歸為半個。

另外還有有兩個較少知名的HTTP動詞：
HEAD - 檢索有關(guān)資源的元數(shù)據(jù)，例如數(shù)據(jù)的哈希或上次更新時間。
OPTIONS - 檢索關(guān)于客戶端被允許對資源做什么的信息。

2、路徑（接口命名）

路徑又稱"終點(diǎn)"（endpoint），表示API的具體網(wǎng)址。

在RESTful架構(gòu)中，每個網(wǎng)址代表一種資源（resource），所以網(wǎng)址中不能有動詞，只能有名詞，而且所用的名詞往往與數(shù)據(jù)庫的表格名對應(yīng)。一般來說，數(shù)據(jù)庫中的表都是同種記錄的"集合"（collection），所以API中的名詞也應(yīng)該使用復(fù)數(shù)。

舉例來說，有一個API提供動物園（zoo）的信息，還包括各種動物和雇員的信息，則它的路徑應(yīng)該設(shè)計(jì)成下面這樣。

接口盡量使用名詞，禁止使用動詞，下面是一些例子。

GET         /zoos：列出所有動物園
POST        /zoos：新建一個動物園
GET         /zoos/ID：獲取某個指定動物園的信息
PUT         /zoos/ID：更新某個指定動物園的信息（提供該動物園的全部信息）
PATCH       /zoos/ID：更新某個指定動物園的信息（提供該動物園的部分信息）
DELETE      /zoos/ID：刪除某個動物園
GET         /zoos/ID/animals：列出某個指定動物園的所有動物
DELETE      /zoos/ID/animals/ID：刪除某個指定動物園的指定動物

反例：

/getAllCars
/createNewCar
/deleteAllRedCars

再比如，某個URI是/posts/show/1，其中show是動詞，這個URI就設(shè)計(jì)錯了，正確的寫法應(yīng)該是/posts/1，然后用GET方法表示show。

如果某些動作是HTTP動詞表示不了的，你就應(yīng)該把動作做成一種資源。比如網(wǎng)上匯款，從賬戶1向賬戶2匯款500元，錯誤的URI是：

　　POST /accounts/1/transfer/500/to/2

正確的寫法是把動詞transfer改成名詞transaction，資源不能是動詞，但是可以是一種服務(wù)：

　　POST /transaction HTTP/1.1
　　Host: 127.0.0.1
　　from=1&to=2&amount=500.00

理清資源的層次結(jié)構(gòu)，比如業(yè)務(wù)針對的范圍是學(xué)校，那么學(xué)校會是一級資源(/school)，老師(/school/teachers)，學(xué)生(/school/students)就是二級資源。

3、版本（Versioning）

應(yīng)該將API的版本號放入U(xiǎn)RL。如：

https://api.example.com/v1/

另一種做法是，將版本號放在HTTP頭信息中，但不如放入U(xiǎn)RL方便和直觀。Github采用這種做法。

4、過濾信息（Filtering）

如果記錄數(shù)量很多，服務(wù)器不可能都將它們返回給用戶。API應(yīng)該提供參數(shù)，過濾返回結(jié)果。
下面是一些常見的參數(shù)。

?limit=10：指定返回記錄的數(shù)量
?offset=10：指定返回記錄的開始位置。
?page_number=2&page_size=100：指定第幾頁，以及每頁的記錄數(shù)。
?sortby=name&order=asc：指定返回結(jié)果按照哪個屬性排序，以及排序順序。
?animal_type_id=1：指定篩選條件
參數(shù)的設(shè)計(jì)允許存在冗余，即允許API路徑和URL參數(shù)偶爾有重復(fù)。比如，
GET /zoo/ID/animals 與 GET /animals?zoo_id=ID 的含義是相同的。

5、狀態(tài)碼（Status Codes）

狀態(tài)碼范圍

1xx 信息，請求收到，繼續(xù)處理。范圍保留用于底層HTTP的東西，你很可能永遠(yuǎn)也用不到。
2xx 成功，行為被成功地接受、理解和采納
3xx 重定向，為了完成請求，必須進(jìn)一步執(zhí)行的動作
4xx 客戶端錯誤，請求包含語法錯誤或者請求無法實(shí)現(xiàn)。范圍保留用于響應(yīng)客戶端做出的錯誤，例如。他們提供不良數(shù)據(jù)或要求不存在的東西。這些請求應(yīng)該是冪等的，而不是更改服務(wù)器的狀態(tài)。
5xx 范圍的狀態(tài)碼是保留給服務(wù)器端錯誤用的。這些錯誤常常是從底層的函數(shù)拋出來的，甚至
開發(fā)人員也通常沒法處理，發(fā)送這類狀態(tài)碼的目的以確保客戶端獲得某種響應(yīng)。
當(dāng)收到5xx響應(yīng)時，客戶端不可能知道服務(wù)器的狀態(tài)，所以這類狀態(tài)碼是要盡可能的避免。

服務(wù)器向用戶返回的狀態(tài)碼和提示信息，常見的有以下一些（方括號中是該狀態(tài)碼對應(yīng)的HTTP動詞）。

200 OK - [GET]：服務(wù)器成功返回用戶請求的數(shù)據(jù)，該操作是冪等的（Idempotent）。
201 CREATED - [POST/PUT/PATCH]：用戶新建或修改數(shù)據(jù)成功。
202 Accepted - [*]：表示一個請求已經(jīng)進(jìn)入后臺排隊(duì)（異步任務(wù)）
204 NO CONTENT - [DELETE]：用戶刪除數(shù)據(jù)成功。
400 INVALID REQUEST - [POST/PUT/PATCH]：用戶發(fā)出的請求有錯誤，服務(wù)器沒有進(jìn)行新建或修改數(shù)據(jù)的操作，該操作是冪等的。
401 Unauthorized - [*]：表示用戶沒有權(quán)限（令牌、用戶名、密碼錯誤）。
403 Forbidden - [*] 表示用戶得到授權(quán)（與401錯誤相對），但是訪問是被禁止的。
404 NOT FOUND - [*]：用戶發(fā)出的請求針對的是不存在的記錄，服務(wù)器沒有進(jìn)行操作，該操作是冪等的。
406 Not Acceptable - [GET]：用戶請求的格式不可得（比如用戶請求JSON格式，但是只有XML格式）。
410 Gone -[GET]：用戶請求的資源被永久刪除，且不會再得到的。
422 Unprocesable entity - [POST/PUT/PATCH] 當(dāng)創(chuàng)建一個對象時，發(fā)生一個驗(yàn)證錯誤。
500 INTERNAL SERVER ERROR - [*]：服務(wù)器發(fā)生錯誤，用戶將無法判斷發(fā)出的請求是否成功。
502 網(wǎng)關(guān)錯誤
503 Service Unavailable
504 網(wǎng)關(guān)超時

參考資料：

RESTful API 設(shè)計(jì)指南--阮一峰：http://www.ruanyifeng.com/blo...