RESTful API設計規範總結

阿新 • • 發佈：2022-05-15

一、重要概念

1、什麼是RESTful設計規範：

    RESTful 是目前最流行的 API 設計規範，用於 Web 資料介面的設計。
    1)每一個URI代表一種資源；
　  2)客戶端和伺服器之間，傳遞這種資源的某種表現層；
　  3)客戶端通過四個HTTP動詞，對伺服器端資源進行操作，實現"表現層狀態轉化"。

二、REST介面規範

1、動作
GET （SELECT）：從伺服器檢索特定資源，或資源列表。
POST （CREATE）：在伺服器上建立一個新的資源。
PUT （UPDATE）：更新伺服器上的資源，提供整個資源。
PATCH （UPDATE）：更新伺服器上的資源，僅提供更改的屬性。
DELETE （DELETE）：從伺服器刪除資源。

2、路徑（介面命名）
路徑又稱"終點"（endpoint），表示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

如果某些動作是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、版本
 應該將API的版本號放入URL。如：
 https://api.example.com/v1/
 
 如果記錄數量很多，伺服器不可能都將它們返回給使用者。API應該提供引數，過濾返回結果。

4、過濾資訊

下面是一些常見的引數。
?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響應時，客戶端不可能知道伺服器的狀態，所以這類狀態碼是要儘可能的避免。

6、常見的有以下一些（方括號中是該狀態碼對應的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 閘道器超時