restful介面設計規範總結
一、重要概念：REST,即Representational State Transfer的縮寫。我對這個片語的翻譯是"表現層狀態轉化"。
Resource（資源） ：物件的單個例項。 例如，一隻動物。它可以是一段文字、一張圖片、一首歌曲、一種服務，總之就是一個具體的實在。
你可以用一個URI（統一資源定位符）指向它，每種資源對應一個特定的URI。要獲取這個資源，訪問它的URI就可以，因此URI就成了每一個資源的地址或獨一無二的識別符。
集合：物件的集合。 例如，動物。
第三方：使用我們介面的開發者
表現層（Representation）
"資源"是一種資訊實體，它可以有多種外在表現形式。我們把"資源"具體呈現出來的形式，叫做它的"表現層"（Representation）。
狀態轉化（State Transfer）
訪問一個網站，就代表了客戶端和伺服器的一個互動過程。在這個過程中，勢必涉及到資料和狀態的變化。網際網路通訊協議HTTP協議，是一個無狀態協議。這意味著，
所有的狀態都儲存在伺服器端。因此，如果客戶端想要操作伺服器，必須通過某種手段，讓伺服器端發生"狀態轉化"（State Transfer）。而這種轉化是建立在表現層之上的，
所以就是"表現層狀態轉化"。
客戶端用到的手段，只能是HTTP協議。具體來說，就是HTTP協議裡面，四個表示操作方式的動詞：GET、POST、PUT、DELETE。
它們分別對應四種基本操作：GET用來獲取資源，POST用來新建資源（也可以用於更新資源），PUT用來更新資源，DELETE用來刪除資源。
比如，文字可以用txt格式表現，也可以用HTML格式、XML格式、JSON格式表現，甚至可以採用二進位制格式；圖片可以用JPG格式表現，也可以用PNG格式表現。
URI只代表資源的實體，不代表它的形式。嚴格地說，有些網址最後的".html"字尾名是不必要的，因為這個字尾名錶示格式，屬於"表現層"範疇，
而URI應該只代表"資源"的位置。它的具體表現形式，應該在HTTP請求的頭資訊中用Accept和Content-Type欄位指定，這兩個欄位才是對"表現層"的描述。
綜合上面的解釋，我們總結一下什麼是RESTful架構：
（1）每一個URI代表一種資源；
（2）客戶端和伺服器之間，傳遞這種資源的某種表現層；
（3）客戶端通過四個HTTP動詞，對伺服器端資源進行操作，實現"表現層狀態轉化"。
二、REST介面規範
1、動作
GET （SELECT）：從伺服器檢索特定資源，或資源列表。
POST （CREATE）：在伺服器上建立一個新的資源。
PUT （UPDATE）：更新伺服器上的資源，提供整個資源。
PATCH （UPDATE）：更新伺服器上的資源，僅提供更改的屬性。
DELETE （DELETE）：從伺服器刪除資源。
首先是四個半種動作：
post、delete、put/patch、get
因為put/patch只能算作一類，所以將patch歸為半個。
另外還有有兩個較少知名的HTTP動詞：
HEAD - 檢索有關資源的元資料，例如資料的雜湊或上次更新時間。
OPTIONS - 檢索關於客戶端被允許對資源做什麼的資訊。
2、路徑（介面命名）
路徑又稱"終點"（endpoint），表示API的具體網址。
在RESTful架構中，每個網址代表一種資源（resource），所以網址中不能有動詞，只能有名詞，而且所用的名詞往往與資料庫的表格名對應。一般來說，資料庫中的表都是同種記錄的"集合"（collection），所以API中的名詞也應該使用複數。
舉例來說，有一個API提供動物園（zoo）的資訊，還包括各種動物和僱員的資訊，則它的路徑應該設計成下面這樣。
介面儘量使用名詞，禁止使用動詞，下面是一些例子。
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就設計錯了，正確的寫法應該是/posts/1，然後用GET方法表示show。
如果某些動作是HTTP動詞表示不了的，你就應該把動作做成一種資源。比如網上匯款，從賬戶1向賬戶2匯款500元，錯誤的URI是：
POST /accounts/1/transfer/500/to/2
正確的寫法是把動詞transfer改成名詞transaction，資源不能是動詞，但是可以是一種服務：
POST /transaction HTTP/1.1
Host: 127.0.0.1
from=1&to=2&amount=500.00
理清資源的層次結構，比如業務針對的範圍是學校，那麼學校會是一級資源(/school)，老師(/school/teachers)，學生(/school/students)就是二級資源。
3、版本（Versioning）
應該將API的版本號放入URL。如：
https://api.example.com/v1/
另一種做法是，將版本號放在HTTP頭資訊中，但不如放入URL方便和直觀。Github採用這種做法。
4、過濾資訊（Filtering）
如果記錄數量很多，伺服器不可能都將它們返回給使用者。API應該提供引數，過濾返回結果。
下面是一些常見的引數。
?limit=10：指定返回記錄的數量
?offset=10：指定返回記錄的開始位置。
?page_number=2&page_size=100：指定第幾頁，以及每頁的記錄數。
?sortby=name&order=asc：指定返回結果按照哪個屬性排序，以及排序順序。
?animal_type_id=1：指定篩選條件
引數的設計允許存在冗餘，即允許API路徑和URL引數偶爾有重複。比如，
GET /zoo/ID/animals 與 GET /animals?zoo_id=ID 的含義是相同的。
5、狀態碼（Status Codes）
狀態碼範圍
1xx 資訊，請求收到，繼續處理。範圍保留用於底層HTTP的東西，你很可能永遠也用不到。
2xx 成功，行為被成功地接受、理解和採納
3xx 重定向，為了完成請求，必須進一步執行的動作
4xx 客戶端錯誤，請求包含語法錯誤或者請求無法實現。範圍保留用於響應客戶端做出的錯誤，例如。他們提供不良資料或要求不存在的東西。這些請求應該是冪等的，而不是更改伺服器的狀態。
5xx 範圍的狀態碼是保留給伺服器端錯誤用的。這些錯誤常常是從底層的函式丟擲來的，甚至
開發人員也通常沒法處理，傳送這類狀態碼的目的以確保客戶端獲得某種響應。
當收到5xx響應時，客戶端不可能知道伺服器的狀態，所以這類狀態碼是要儘可能的避免。
伺服器向用戶返回的狀態碼和提示資訊，常見的有以下一些（方括號中是該狀態碼對應的HTTP動詞）。
200 OK - [GET]：伺服器成功返回使用者請求的資料，該操作是冪等的（Idempotent）。
201 CREATED - [POST/PUT/PATCH]：使用者新建或修改資料成功。
202 Accepted - [*]：表示一個請求已經進入後臺排隊（非同步任務）
204 NO CONTENT - [DELETE]：使用者刪除資料成功。
400 INVALID REQUEST - [POST/PUT/PATCH]：使用者發出的請求有錯誤，伺服器沒有進行新建或修改資料的操作，該操作是冪等的。
401 Unauthorized - [*]：表示使用者沒有許可權（令牌、使用者名稱、密碼錯誤）。
403 Forbidden - [*] 表示使用者得到授權（與401錯誤相對），但是訪問是被禁止的。
404 NOT FOUND - [*]：使用者發出的請求針對的是不存在的記錄，伺服器沒有進行操作，該操作是冪等的。
406 Not Acceptable - [GET]：使用者請求的格式不可得（比如使用者請求JSON格式，但是隻有XML格式）。
410 Gone -[GET]：使用者請求的資源被永久刪除，且不會再得到的。
422 Unprocesable entity - [POST/PUT/PATCH] 當建立一個物件時，發生一個驗證錯誤。
500 INTERNAL SERVER ERROR - [*]：伺服器發生錯誤，使用者將無法判斷髮出的請求是否成功。
502 閘道器錯誤
503 Service Unavailable
504 閘道器超時
錯誤處理（Error handling）
如果狀態碼是4xx，就應該向使用者返回出錯資訊。一般來說，返回的資訊中將error作為鍵名，出錯資訊作為鍵值即可。
{
error: "Invalid API key"
}
返回結果
針對不同操作，伺服器向用戶返回的結果應該符合以下規範。
GET /collection：返回資源物件的列表（陣列）
GET /collection/resource：返回單個資源物件
POST /collection：返回新生成的資源物件
PUT /collection/resource：返回完整的資源物件
PATCH /collection/resource：返回完整的資源物件
DELETE /collection/resource：返回一個空文件
Hypermedia API
RESTful API最好做到Hypermedia，即返回結果中提供連結，連向其他API方法，使得使用者不查文件，也知道下一步應該做什麼。
比如，當用戶向api.example.com的根目錄發出請求，會得到這樣一個文件。
{"link": {
"rel": "collection https://www.example.com/zoos",
"href": "https://api.example.com/zoos",
"title": "List of zoos",
"type": "application/vnd.yourformat+json"
}}
上面程式碼表示，文件中有一個link屬性，使用者讀取這個屬性就知道下一步該呼叫什麼API了。rel表示這個API與當前網址的關係（collection關係，並給出該collection的網址），href表示API的路徑，title表示API的標題，type表示返回型別。
Hypermedia API的設計被稱為HATEOAS。Github的API就是這種設計，訪問api.github.com會得到一個所有可用API的網址列表。
{
"current_user_url": "https://api.github.com/user",
"authorizations_url": "https://api.github.com/authorizations",
// ...
}
從上面可以看到，如果想獲取當前使用者的資訊，應該去訪問api.github.com/user，然後就得到了下面結果。
{
"message": "Requires authentication",
"documentation_url": "https://developer.github.com/v3"
}
上面程式碼表示，伺服器給出了提示資訊，以及文件的網址。
Linux公社的RSS地址 ：ofollow,noindex" target="_blank">https://www.linuxidc.com/rssFeed.aspx
本文永久更新連結地址：https://www.linuxidc.com/Linux/2018-09/154470.htm