restful-api · 全棧之路

## RESTful架構　　（1）每一個URI代表一種資源；　　（2）客戶端和服務器之間，傳遞這種資源的某種表現層；　　（3）客戶端通過四個HTTP動詞，對服務器端資源進行操作，實現"表現層狀態轉化"。 ## [](#%E5%8D%8F%E8%AE%AE)協議 HTTP/HTTPS ## [](#%E5%9F%9F%E5%90%8D)域名應該盡量將API部署在專用域名之下。 [https://api.example.com](https://api.example.com) 如果確定API很簡單，不會有進一步擴展，可以考慮放在主域名下。 [https://example.org/api/](https://example.org/api/) ## [](#%E7%89%88%E6%9C%AC)版本應該將API的版本號放入URL。 [https://api.example.com/v1/](https://api.example.com/v1/) 另一種做法是，將版本號放在HTTP頭信息中，但不如放入URL方便和直觀。Github采用這種做法。 ## [](#%E8%B7%AF%E5%BE%84)路徑路徑又稱"終點"（endpoint），表示API的具體網址。在RESTful架構中，每個網址代表一種資源（resource），所以網址中不能有動詞，只能有名詞，而且所用的名詞往往與數據庫的表格名對應。一般來說，數據庫中的表都是同種記錄的"集合"（collection），所以API中的名詞也應該使用復數。舉例來說，有一個API提供動物園（zoo）的信息，還包括各種動物和雇員的信息，則它的路徑應該設計成下面這樣。 ~~~ https://api.example.com/v1/zoos https://api.example.com/v1/animals https://api.example.com/v1/employees ~~~ ## [](#http%E5%8A%A8%E8%AF%8D)HTTP動詞對于資源的具體操作類型，由HTTP動詞表示。常用的HTTP動詞有下面五個（括號里是對應的SQL命令）。 ~~~ GET（SELECT）：從服務器取出資源（一項或多項）。 POST（CREATE）：在服務器新建一個資源。 PUT（UPDATE）：在服務器更新資源（客戶端提供改變后的完整資源）。 PATCH（UPDATE）：在服務器更新資源（客戶端提供改變的屬性）。 DELETE（DELETE）：從服務器刪除資源。 ~~~ 下面是一些例子。 ~~~ 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：刪除某個指定動物園的指定動物 ~~~ ## [](#%E8%BF%87%E6%BB%A4%E4%BF%A1%E6%81%AF)過濾信息如果記錄數量很多，服務器不可能都將它們返回給用戶。API應該提供參數，過濾返回結果。下面是一些常見的參數。 ~~~ ?limit=10：指定返回記錄的數量 ?offset=10：指定返回記錄的開始位置。 ?page=2&per_page=100：指定第幾頁，以及每頁的記錄數。 ?sortby=name&order=asc：指定返回結果按照哪個屬性排序，以及排序順序。 ?animal_type_id=1：指定篩選條件 ~~~ ## [](#%E7%8A%B6%E6%80%81%E7%A0%81)狀態碼 ~~~ 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 - [*]：服務器發生錯誤，用戶將無法判斷發出的請求是否成功。 ~~~ ## [](#%E8%BF%94%E5%9B%9E%E7%BB%93%E6%9E%9C)返回結果 ~~~ GET /collection：返回資源對象的列表（數組） GET /collection/resource：返回單個資源對象 POST /collection：返回新生成的資源對象 PUT /collection/resource：返回完整的資源對象 PATCH /collection/resource：返回完整的資源對象 DELETE /collection/resource：返回一個空文檔 ~~~ references: [http://www.ruanyifeng.com/blog/2014/05/restful\_api.html](http://www.ruanyifeng.com/blog/2014/05/restful_api.html)