轉載：阮一峰 Rest API設計原則

標籤：des   class   blog   c   code   tar   

　網路應用程式，分為前端和後端兩個部分。當前的發展趨勢，就是前端裝置層出不窮（手機、平板、案頭電腦、其他專用裝置......）。

　　因此，必須有一種統一的機制，方便不同的前端裝置與後端進行通訊。這導致 API 構架的流行，甚至出現"API First"的設計思想。RESTful API 是目前比較成熟的一套互連網應用程式的 API 設計理論。我以前寫過一篇《理解 RESTful 架構》，探討如何理解這個概念。

　　今天，我將介紹 RESTful API 的設計細節，探討如何設計一套合理、好用的 API。我的主要參考資料是這篇《Principles of good RESTful API Design》。

　　一、協議

　　API 與使用者的通訊協定，總是使用 HTTPs 協議。

　　二、網域名稱

　　應該盡量將 API 部署在專用網域名稱之下。

https://api.example.com

　　如果確定 API 很簡單，不會有進一步擴充，可以考慮放在主網域名稱下。

https://example.org/api/

　　三、版本（Versioning）

　　應該將 API 的版本號碼放入 URL。

https://api.example.com/v1/

　　另一種做法是，將版本號碼放在 HTTP 頭資訊中，但不如放入 URL 方便和直觀。

　　四、路徑（Endpoint）

　　路徑又稱"終點"（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 動詞

　　對於資源的具體操作類型，由 HTTP 動詞表示。

　　常用的 HTTP 動詞有下面五個（括弧裡是對應的 SQL 命令）。

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

　　還有兩個不常用的 HTTP 動詞。

HEAD：擷取資源的中繼資料。
OPTIONS：擷取資訊，關於資源的哪些屬性是用戶端可以改變的。

　　下面是一些例子。

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：刪除某個指定動物園的指定動物

　　六、過濾資訊（Filtering）

　　如果記錄數量很多，伺服器不可能都將它們返回給使用者。API 應該提供參數，過濾返回結果。

　　下面是一些常見的參數。

?limit=10：指定返回記錄的數量
?offset=10：指定返回記錄的開始位置。
?sortby=name&order=asc：指定返回結果按照哪個屬性排序，以及排序次序。
?animal typeid=1：指定篩選條件

　　參數的設計允許存在冗餘，即允許 API 路徑和 URL 參數偶爾有重複。比如，GET /zoo/ID/animals 與 GET /animals?zoo_id=ID 的含義是相同的。

　　七、狀態代碼（Status Codes）

　　伺服器向使用者返回的狀態代碼和提示資訊，常見的有以下一些（方括弧中是該狀態代碼對應的 HTTP 動詞）。

200 OK - [GET]：伺服器成功返回使用者請求的資料，該操作是等冪的（Idempotent）。
201 CREATED - [POST/PUT/PATCH]：使用者建立或修改資料成功。
204 NO CONTENT - [DELETE]：使用者刪除資料成功。
400 INVALID REQUEST - [POST/PUT/PATCH]：使用者發出的請求有錯誤，伺服器沒有進行建立或修改資料的操作，該操作是等冪的。。
404 NOT FOUND - [*]：使用者發出的請求針對的是不存在的記錄，伺服器沒有進行操作，該操作是等冪的。
500 INTERNAL SERVER ERROR - [*]：伺服器發生錯誤，使用者將無法判斷髮出的請求是否成功。

　　狀態代碼的完全列表參見這裡。

　　八、返回結果

　　針對不同操作，伺服器向使用者返回的結果應該符合以下規範。

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"}

　　上面代碼錶示，伺服器給出了提示資訊，以及文檔的網址。

　　十、其他

　　（1）API 的身份認證應該使用 OAuth 2.0架構。

　　（2）伺服器返回的資料格式，應該盡量使用 JSON，避免使用 XML。

　　（完）