作者： 阮一峰
日期： 2014年5月22日
網絡應用程序蹂匹，分為前端和后端兩個部分碘菜。當前的發(fā)展趨勢，就是前端設備層出不窮（手機怒详、平板炉媒、桌面電腦踪区、其他專用設備......）昆烁。
因此，必須有一種統(tǒng)一的機制缎岗，方便不同的前端設備與后端進行通信静尼。這導致API構架的流行，甚至出現"API First"的設計思想传泊。RESTful API是目前比較成熟的一套互聯網應用程序的API設計理論鼠渺。我以前寫過一篇《理解RESTful架構》，探討如何理解這個概念眷细。
今天拦盹，我將介紹RESTful API的設計細節(jié)，探討如何設計一套合理溪椎、好用的API普舆。我的主要參考了兩篇文章（1，2）校读。
一沼侣、協(xié)議
API與用戶的通信協(xié)議，總是使用HTTPs協(xié)議歉秫。
二蛾洛、域名
應該盡量將API部署在專用域名之下。
https://api.example.com
如果確定API很簡單雁芙，不會有進一步擴展轧膘，可以考慮放在主域名下钞螟。
https://example.org/api/
三、版本（Versioning）
應該將API的版本號放入URL谎碍。
https://api.example.com/v1/
另一種做法是筛圆，將版本號放在HTTP頭信息中，但不如放入URL方便和直觀椿浓。Github采用這種做法太援。
四、路徑（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：指定返回記錄的開始位置趣倾。
- ?page=2&per_page=100：指定第幾頁聘惦，以及每頁的記錄數。
- ?sortby=name&order=asc：指定返回結果按照哪個屬性排序儒恋，以及排序順序善绎。
- ?animal_type_id=1：指定篩選條件
參數的設計允許存在冗余，即允許API路徑和URL參數偶爾有重復诫尽。比如禀酱，GET /zoo/ID/animals 與 GET /animals?zoo_id=ID 的含義是相同的。
七牧嫉、狀態(tài)碼（Status Codes）
服務器向用戶返回的狀態(tài)碼和提示信息剂跟，常見的有以下一些（方括號中是該狀態(tài)碼對應的HTTP動詞）。
- 200 OK - [GET]：服務器成功返回用戶請求的數據酣藻，該操作是冪等的（Idempotent）曹洽。
- 201 CREATED - [POST/PUT/PATCH]：用戶新建或修改數據成功。
- 202 Accepted - [*]：表示一個請求已經進入后臺排隊（異步任務）
- 204 NO CONTENT - [DELETE]：用戶刪除數據成功辽剧。
- 400 INVALID REQUEST - [POST/PUT/PATCH]：用戶發(fā)出的請求有錯誤送淆，服務器沒有進行新建或修改數據的操作，該操作是冪等的抖仅。
- 401 Unauthorized - [*]：表示用戶沒有權限（令牌坊夫、用戶名、密碼錯誤）撤卢。
- 403 Forbidden - [*] 表示用戶得到授權（與401錯誤相對），但是訪問是被禁止的梧兼。
- 404 NOT FOUND - [*]：用戶發(fā)出的請求針對的是不存在的記錄放吩，服務器沒有進行操作，該操作是冪等的羽杰。
- 406 Not Acceptable - [GET]：用戶請求的格式不可得（比如用戶請求JSON格式渡紫，但是只有XML格式）。
- 410 Gone -[GET]：用戶請求的資源被永久刪除考赛，且不會再得到的惕澎。
- 422 Unprocesable entity - [POST/PUT/PATCH] 當創(chuàng)建一個對象時，發(fā)生一個驗證錯誤颜骤。
- 500 INTERNAL SERVER ERROR - [*]：服務器發(fā)生錯誤唧喉，用戶將無法判斷發(fā)出的請求是否成功。
狀態(tài)碼的完全列表參見這里。
八八孝、錯誤處理（Error handling）
如果狀態(tài)碼是4xx董朝，就應該向用戶返回出錯信息。一般來說干跛，返回的信息中將error作為鍵名子姜，出錯信息作為鍵值即可。
{ error: "Invalid API key"}
九楼入、返回結果
針對不同操作哥捕，服務器向用戶返回的結果應該符合以下規(guī)范。
- 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的根目錄發(fā)出請求御蒲，會得到這樣一個文檔。
{
"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宏赘。
（完）
