RESTful API 設(shè)計指南
轉(zhuǎn)載：http://www.ruanyifeng.com/blog/2014/05/restful_api.html
[TOC]
網(wǎng)絡(luò)應(yīng)用程序耸峭，分為前端和后端兩個部分恋博。當(dāng)前的發(fā)展趨勢今魔，就是前端設(shè)備層出不窮（手機(jī)玄组、平板、桌面電腦胧辽、其他專用設(shè)備......）峻仇。
因此，必須有一種統(tǒng)一的機(jī)制邑商，方便不同的前端設(shè)備與后端進(jìn)行通信摄咆。這導(dǎo)致API構(gòu)架的流行，甚至出現(xiàn)"API First"的設(shè)計思想人断。RESTful API是目前比較成熟的一套互聯(lián)網(wǎng)應(yīng)用程序的API設(shè)計理論吭从。關(guān)于RESTFUL請看這里《理解RESTful架構(gòu)》探討如何理解這個概念。
今天恶迈，將介紹RESTful API的設(shè)計細(xì)節(jié)涩金，探討如何設(shè)計一套合理、好用的API暇仲。主要參考了兩篇文章（1步做，2）。
一奈附、協(xié)議
API與用戶的通信協(xié)議辆床，總是使用HTTPs協(xié)議。
二桅狠、域名
應(yīng)該盡量將API部署在專用域名之下。
https://api.example.com
如果確定API很簡單，不會有進(jìn)一步擴(kuò)展中跌，可以考慮放在主域名下咨堤。
https://example.org/api/
三、版本（Versioning）
應(yīng)該將API的版本號放入URL漩符。
https://api.example.com/v1/
另一種做法是一喘，將版本號放在HTTP頭信息中，但不如放入URL方便和直觀嗜暴。Github采用這種做法凸克。
四、路徑（Endpoint）
路徑又稱"終點"（endpoint）闷沥，表示API的具體網(wǎng)址萎战。
在RESTful架構(gòu)中，每個網(wǎng)址代表一種資源（resource）舆逃，所以網(wǎng)址中不能有動詞蚂维，只能有名詞，而且所用的名詞往往與數(shù)據(jù)庫的表格名對應(yīng)路狮。一般來說虫啥，數(shù)據(jù)庫中的表都是同種記錄的"集合"（collection），所以API中的名詞也應(yīng)該使用復(fù)數(shù)奄妨。
舉例來說涂籽，有一個API提供動物園（zoo）的信息，還包括各種動物和雇員的信息砸抛，則它的路徑應(yīng)該設(shè)計成下面這樣评雌。
五、HTTP動詞
對于資源的具體操作類型锰悼，由HTTP動詞表示柳骄。
常用的HTTP動詞有下面五個（括號里是對應(yīng)的SQL命令）。
- GET（SELECT）：從服務(wù)器取出資源（一項或多項）箕般。
- POST（CREATE）：在服務(wù)器新建一個資源耐薯。
- PUT（UPDATE）：在服務(wù)器更新資源（客戶端提供改變后的完整資源）。
- PATCH（UPDATE）：在服務(wù)器更新資源（客戶端提供改變的屬性）丝里。
- DELETE（DELETE）：從服務(wù)器刪除資源曲初。
還有兩個不常用的HTTP動詞。
- HEAD：獲取資源的元數(shù)據(jù)杯聚。
- OPTIONS：獲取信息臼婆，關(guān)于資源的哪些屬性是客戶端可以改變的。
下面是一些例子幌绍。
- 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）
如果記錄數(shù)量很多故响，服務(wù)器不可能都將它們返回給用戶。API應(yīng)該提供參數(shù)颁独，過濾返回結(jié)果彩届。
下面是一些常見的參數(shù)。
- ?limit=10：指定返回記錄的數(shù)量
- ?offset=10：指定返回記錄的開始位置誓酒。
- ?page=2&per_page=100：指定第幾頁樟蠕，以及每頁的記錄數(shù)。
- ?sortby=name&order=asc：指定返回結(jié)果按照哪個屬性排序靠柑，以及排序順序寨辩。
- ?animal_type_id=1：指定篩選條件
參數(shù)的設(shè)計允許存在冗余，即允許API路徑和URL參數(shù)偶爾有重復(fù)歼冰。比如靡狞，GET /zoo/ID/animals 與 GET /animals?zoo_id=ID 的含義是相同的。
七停巷、狀態(tài)碼（Status Codes）
服務(wù)器向用戶返回的狀態(tài)碼和提示信息耍攘，常見的有以下一些（方括號中是該狀態(tài)碼對應(yīng)的HTTP動詞）。
- 200 OK - [GET]：服務(wù)器成功返回用戶請求的數(shù)據(jù)畔勤，該操作是冪等的（Idempotent）蕾各。
- 201 CREATED - [POST/PUT/PATCH]：用戶新建或修改數(shù)據(jù)成功。
- 202 Accepted - [*]：表示一個請求已經(jīng)進(jìn)入后臺排隊（異步任務(wù)）
- 204 NO CONTENT - [DELETE]：用戶刪除數(shù)據(jù)成功庆揪。
- 400 INVALID REQUEST - [POST/PUT/PATCH]：用戶發(fā)出的請求有錯誤式曲，服務(wù)器沒有進(jìn)行新建或修改數(shù)據(jù)的操作，該操作是冪等的缸榛。
- 401 Unauthorized - [*]：表示用戶沒有權(quán)限（令牌吝羞、用戶名、密碼錯誤）内颗。
- 403 Forbidden - [*] 表示用戶得到授權(quán)（與401錯誤相對）钧排，但是訪問是被禁止的。
- 404 NOT FOUND - [*]：用戶發(fā)出的請求針對的是不存在的記錄均澳，服務(wù)器沒有進(jìn)行操作恨溜，該操作是冪等的。
- 406 Not Acceptable - [GET]：用戶請求的格式不可得（比如用戶請求JSON格式找前，但是只有XML格式）糟袁。
- 410 Gone -[GET]：用戶請求的資源被永久刪除，且不會再得到的躺盛。
- 422 Unprocesable entity - [POST/PUT/PATCH] 當(dāng)創(chuàng)建一個對象時项戴，發(fā)生一個驗證錯誤。
- 500 INTERNAL SERVER ERROR - [*]：服務(wù)器發(fā)生錯誤槽惫，用戶將無法判斷發(fā)出的請求是否成功周叮。
狀態(tài)碼的完全列表參見這里辩撑。
八、錯誤處理（Error handling）
如果狀態(tài)碼是4xx则吟，就應(yīng)該向用戶返回出錯信息槐臀。一般來說，返回的信息中將error作為鍵名氓仲，出錯信息作為鍵值即可。
{ error: "Invalid API key" }
九得糜、返回結(jié)果
針對不同操作敬扛，服務(wù)器向用戶返回的結(jié)果應(yīng)該符合以下規(guī)范。
- GET /collection：返回資源對象的列表（數(shù)組）
- GET /collection/resource：返回單個資源對象
- POST /collection：返回新生成的資源對象
- PUT /collection/resource：返回完整的資源對象
- PATCH /collection/resource：返回完整的資源對象
- DELETE /collection/resource：返回一個空文檔
十朝抖、Hypermedia API
RESTful API最好做到Hypermedia啥箭，即返回結(jié)果中提供鏈接，連向其他API方法治宣，使得用戶不查文檔急侥，也知道下一步應(yīng)該做什么。
比如侮邀，當(dāng)用戶向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屬性铝宵，用戶讀取這個屬性就知道下一步該調(diào)用什么API了。rel表示這個API與當(dāng)前網(wǎng)址的關(guān)系（collection關(guān)系华畏，并給出該collection的網(wǎng)址）鹏秋，href表示API的路徑，title表示API的標(biāo)題亡笑，type表示返回類型侣夷。
Hypermedia API的設(shè)計被稱為HATEOAS。Github的API就是這種設(shè)計仑乌，訪問api.github.com會得到一個所有可用API的網(wǎng)址列表百拓。
{ "current_user_url": "https://api.github.com/user", "authorizations_url": "https://api.github.com/authorizations", // ... }
從上面可以看到，如果想獲取當(dāng)前用戶的信息绝骚，應(yīng)該去訪問api.github.com/user耐版，然后就得到了下面結(jié)果。
{ "message": "Requires authentication", "documentation_url": "https://developer.github.com/v3" }
上面代碼表示压汪，服務(wù)器給出了提示信息粪牲，以及文檔的網(wǎng)址。
十一止剖、其他
（1）API的身份認(rèn)證應(yīng)該使用OAuth 2.0框架腺阳。
（2）服務(wù)器返回的數(shù)據(jù)格式落君，應(yīng)該盡量使用JSON，避免使用XML亭引。
