RestFul API 知識

RestFul API 是每個程式員都應該了解并掌握的基本知識，我們在開發過程中設計API的時候也應該至少要滿足RestFul API的最基本的要求（比如接口中盡量使用名詞，使用POST 請求建立資源，DELETE請求删除資源等等，示例：GET     /notes/id：擷取某個指定id的筆記的資訊）。

一、概念：

REST,即Representational State Transfer的縮寫，翻譯過來就是"表現層狀态轉化"。

• Resource（資源） ：對象的單個執行個體。例如，一隻動物。它可以是一段文本、一張圖檔、一首歌曲、一種服務，總之就是一個具體的實在。你可以用一個URI（統一資源定位符）指向它，每種資源對應一個特定的URI。要擷取這個資源，通路它的URI就可以，是以URI就成了每一個資源的位址或獨一無二的識别符。
• 集合：對象的集合。例如，動物。
• 第三方：使用我們接口的開發者
• 表現層（Representation）："資源"是一種資訊實體，它可以有多種外在表現形式。我們把"資源"具體呈現出來的形式，叫做它的"表現層"（Representation）。
• 狀态轉化（State Transfer） 通路一個網站，就代表了用戶端和伺服器的一個互動過程。在這個過程中，勢必涉及到資料和狀态的變化。網際網路通信協定HTTP協定，是一個無狀态協定。這意味着，所有的狀态都儲存在伺服器端。是以，如果用戶端想要操作伺服器，必須通過某種手段，讓伺服器端發生"狀态轉化"（State Transfer）。而這種轉化是建立在表現層之上的，是以就是"表現層狀态轉化"。

綜合上面的解釋，我們總結一下什麼是RESTful架構：

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

　（2）用戶端和伺服器之間，傳遞這種資源的某種表現層；

　（3）用戶端通過HTTP動詞(GET,POST等等)，對伺服器端資源進行操作，實作"表現層狀态轉化"。

二、REST接口規範

1、動作

• GET （SELECT）：從伺服器檢索特定資源，或資源清單。
• POST （CREATE）：在伺服器上建立一個新的資源。
• PUT （UPDATE）：更新伺服器上的資源（用戶端提供更新後的整個資源）。
• PATCH （UPDATE）：更新伺服器上的資源（用戶端提供更改的屬性，可以看做作是部分更新）。
• DELETE （DELETE）：從伺服器删除資源。

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：删除某個指定動物園的指定動物複制代碼
           

再比如，某個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
           

3、版本（Versioning）

應該将API的版本号放入URL。如：

https://api.example.com/v1/複制代碼
           

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 網關逾時