瞭解 RESTful API

REST，即 REpresentational State Transfer，其主語是 Resource，可是被省略掉了，因此全稱是：Resource Representational State Transfer。按照字面意思來理解就是：資源在網絡中以某種表現形式進行狀態轉移，這樣的直譯，我相信絕大多數看了都是困惑的，用人人都能理解的話來講，就是用 URL 來定位資源，用 HTTP 來描述操做，詳細展開就是：

• 看 URL 就知道要什麼
• 看 HTTP method 就知道幹什麼
• 看 HTTP status code 就知道結果如何

REST 是一種設計風格（不是標準），是一組架構的約束條件和原則，知足這些約束條件和原則的應用程序或設計就是 RESTful。其次，REST 是面向資源的，而資源是經過 URL 進行暴露的。理解這兩點對認識 REST 和 RESTful 很是重要。

那咱們的 API 應該如何設計，才能知足 RESTful API 的要求呢？

HTTP 動詞

對資源的具體操做類型，應該由 HTTP 動詞表示，具體以下（括號裏是對應的 SQL 命令）：

• GET（SELECT）：從服務器取出資源（一項或多項）
• POST（CREATE）：在服務器新建一個資源
• PUT（UPDATE）：在服務器更新資源（客戶端提供改變後的完整資源）
• PATCH（UPDATE）：在服務器更新資源（客戶端提供改變的屬性）
• DELETE（DELETE）：從服務器刪除資源

還有兩個不經常使用的 HTTP 動詞：

• HEAD：獲取資源的元數據
• OPTIONS：獲取信息，關於資源的哪些屬性是客戶端能夠改變的

過濾數據

若是查詢出的數據不少，API 應該提供參數，將數據的過濾結果進行返回，常見的過濾參數以下：

• ?limit=10：指定返回記錄的數量
• ?offset=10：指定返回記錄的開始位置。
• ?page=2&per_page=100：指定第幾頁，以及每頁的記錄數。
• ?sortby=name&order=asc：指定返回結果按照哪一個屬性排序，以及排序順序。
• ?animal_type_id=1：指定篩選條件

參數的設計是容許存在冗餘的。

狀態碼

服務器向用戶返回的狀態碼和提示信息，常見的有如下一些（方括號中是該狀態碼對應的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 - [*]：服務器發生錯誤，用戶將沒法判斷髮出的請求是否成功。

錯誤處理

若是狀態碼是 4xx，就應該向用戶返回出錯信息。通常來講，返回的信息中將 error 做爲鍵名，出錯信息做爲鍵值便可：

{
    error: "Invalid API key"
}
複製代碼

返回結果

針對不一樣操做，服務器向用戶返回的結果應該符合如下規範：

• GET /collection：返回資源對象的列表（數組）
• GET /collection/resource：返回單個資源對象
• POST /collection：返回新生成的資源對象
• PUT /collection/resource：返回完整的資源對象
• PATCH /collection/resource：返回完整的資源對象
• DELETE /collection/resource：返回一個空文檔

其餘

• API 的身份認證應該使用 OAuth 2.0 框架
• 服務器返回的數據格式，應該儘可能使用JSON，避免使用XML

參考連接：

• RESTful API 設計指南
• 理解RESTful架構