作者:阮一峰(http://www.ruanyifeng.com/blog/2014/05/)
網(wǎng)絡(luò)應(yīng)用程序，分為前端和后端兩個(gè)部分张抄。當(dāng)前的發(fā)展趨勢(shì)徽千，就是前端設(shè)備層出不窮（手機(jī)忠藤、平板、桌面電腦真竖、其他專用設(shè)備......）。
因此厌小，必須有一種統(tǒng)一的機(jī)制疼邀，方便不同的前端設(shè)備與后端進(jìn)行通信。這導(dǎo)致API構(gòu)架的流行召锈，甚至出現(xiàn)"API First"的設(shè)計(jì)思想旁振。RESTful API是目前比較成熟的一套互聯(lián)網(wǎng)應(yīng)用程序的API設(shè)計(jì)理論。我以前寫過一篇《理解RESTful架構(gòu)》涨岁，探討如何理解這個(gè)概念拐袜。
今天，我將介紹RESTful API的設(shè)計(jì)細(xì)節(jié)梢薪，探討如何設(shè)計(jì)一套合理蹬铺、好用的API。我的主要參考了兩篇文章（1秉撇，2）甜攀。
一、協(xié)議
API與用戶的通信協(xié)議琐馆，總是使用HTTPs協(xié)議规阀。
二、域名
應(yīng)該盡量將API部署在專用域名之下瘦麸。
https://api.example.com
如果確定API很簡(jiǎn)單铭腕，不會(huì)有進(jìn)一步擴(kuò)展达罗，可以考慮放在主域名下包竹。
https://example.org/api/
三、版本（Versioning）
應(yīng)該將API的版本號(hào)放入U(xiǎn)RL喊巍。
https://api.example.com/v1/
另一種做法是，將版本號(hào)放在HTTP頭信息中箍鼓，但不如放入U(xiǎn)RL方便和直觀崭参。Github采用這種做法。
四款咖、路徑（Endpoint）
路徑又稱"終點(diǎn)"（endpoint）阵翎，表示API的具體網(wǎng)址。
在RESTful架構(gòu)中之剧，每個(gè)網(wǎng)址代表一種資源（resource）郭卫，所以網(wǎng)址中不能有動(dòng)詞，只能有名詞背稼，而且所用的名詞往往與數(shù)據(jù)庫的表格名對(duì)應(yīng)贰军。一般來說，數(shù)據(jù)庫中的表都是同種記錄的"集合"（collection）蟹肘，所以API中的名詞也應(yīng)該使用復(fù)數(shù)词疼。
舉例來說，有一個(gè)API提供動(dòng)物園（zoo）的信息帘腹，還包括各種動(dòng)物和雇員的信息贰盗，則它的路徑應(yīng)該設(shè)計(jì)成下面這樣。
https://api.example.com/v1/zoos
https://api.example.com/v1/animals
https://api.example.com/v1/employees
五阳欲、HTTP動(dòng)詞
對(duì)于資源的具體操作類型舵盈，由HTTP動(dòng)詞表示。
常用的HTTP動(dòng)詞有下面五個(gè)（括號(hào)里是對(duì)應(yīng)的SQL命令）球化。
GET（SELECT）：從服務(wù)器取出資源（一項(xiàng)或多項(xiàng)）秽晚。
POST（CREATE）：在服務(wù)器新建一個(gè)資源。
PUT（UPDATE）：在服務(wù)器更新資源（客戶端提供改變后的完整資源）筒愚。
PATCH（UPDATE）：在服務(wù)器更新資源（客戶端提供改變的屬性）赴蝇。
DELETE（DELETE）：從服務(wù)器刪除資源。
還有兩個(gè)不常用的HTTP動(dòng)詞巢掺。
HEAD：獲取資源的元數(shù)據(jù)句伶。
OPTIONS：獲取信息，關(guān)于資源的哪些屬性是客戶端可以改變的陆淀。
下面是一些例子考余。
GET /zoos：列出所有動(dòng)物園
POST /zoos：新建一個(gè)動(dòng)物園
GET /zoos/ID：獲取某個(gè)指定動(dòng)物園的信息
PUT /zoos/ID：更新某個(gè)指定動(dòng)物園的信息（提供該動(dòng)物園的全部信息）
PATCH /zoos/ID：更新某個(gè)指定動(dòng)物園的信息（提供該動(dòng)物園的部分信息）
DELETE /zoos/ID：刪除某個(gè)動(dòng)物園
GET /zoos/ID/animals：列出某個(gè)指定動(dòng)物園的所有動(dòng)物
DELETE /zoos/ID/animals/ID：刪除某個(gè)指定動(dòng)物園的指定動(dòng)物
六、過濾信息（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é)果按照哪個(gè)屬性排序，以及排序順序重罪。
?animal_type_id=1：指定篩選條件
參數(shù)的設(shè)計(jì)允許存在冗余樱哼，即允許API路徑和URL參數(shù)偶爾有重復(fù)。比如剿配，GET /zoo/ID/animals 與 GET /animals?zoo_id=ID 的含義是相同的搅幅。
七、狀態(tài)碼（Status Codes）
服務(wù)器向用戶返回的狀態(tài)碼和提示信息呼胚，常見的有以下一些（方括號(hào)中是該狀態(tài)碼對(duì)應(yīng)的HTTP動(dòng)詞）茄唐。
200 OK - [GET]：服務(wù)器成功返回用戶請(qǐng)求的數(shù)據(jù)，該操作是冪等的（Idempotent）蝇更。
201 CREATED - [POST/PUT/PATCH]：用戶新建或修改數(shù)據(jù)成功沪编。
202 Accepted - [*]：表示一個(gè)請(qǐng)求已經(jīng)進(jìn)入后臺(tái)排隊(duì)（異步任務(wù)）
204 NO CONTENT - [DELETE]：用戶刪除數(shù)據(jù)成功。
400 INVALID REQUEST - [POST/PUT/PATCH]：用戶發(fā)出的請(qǐng)求有錯(cuò)誤年扩，服務(wù)器沒有進(jìn)行新建或修改數(shù)據(jù)的操作蚁廓，該操作是冪等的。
401 Unauthorized - [*]：表示用戶沒有權(quán)限（令牌厨幻、用戶名相嵌、密碼錯(cuò)誤）。
403 Forbidden - [*] 表示用戶得到授權(quán)（與401錯(cuò)誤相對(duì)）况脆，但是訪問是被禁止的平绩。
404 NOT FOUND - [*]：用戶發(fā)出的請(qǐng)求針對(duì)的是不存在的記錄，服務(wù)器沒有進(jìn)行操作漠另，該操作是冪等的捏雌。
406 Not Acceptable - [GET]：用戶請(qǐng)求的格式不可得（比如用戶請(qǐng)求JSON格式，但是只有XML格式）笆搓。
410 Gone -[GET]：用戶請(qǐng)求的資源被永久刪除性湿，且不會(huì)再得到的。
422 Unprocesable entity - [POST/PUT/PATCH] 當(dāng)創(chuàng)建一個(gè)對(duì)象時(shí)满败，發(fā)生一個(gè)驗(yàn)證錯(cuò)誤肤频。
500 INTERNAL SERVER ERROR - [*]：服務(wù)器發(fā)生錯(cuò)誤，用戶將無法判斷發(fā)出的請(qǐng)求是否成功算墨。
狀態(tài)碼的完全列表參見這里宵荒。
八、錯(cuò)誤處理（Error handling）
如果狀態(tài)碼是4xx，就應(yīng)該向用戶返回出錯(cuò)信息报咳。一般來說侠讯，返回的信息中將error作為鍵名，出錯(cuò)信息作為鍵值即可暑刃。
{ error: "Invalid API key"}
九厢漩、返回結(jié)果
針對(duì)不同操作，服務(wù)器向用戶返回的結(jié)果應(yīng)該符合以下規(guī)范岩臣。
GET /collection：返回資源對(duì)象的列表（數(shù)組）
GET /collection/resource：返回單個(gè)資源對(duì)象
POST /collection：返回新生成的資源對(duì)象
PUT /collection/resource：返回完整的資源對(duì)象
PATCH /collection/resource：返回完整的資源對(duì)象
DELETE /collection/resource：返回一個(gè)空文檔
十溜嗜、Hypermedia API
RESTful API最好做到Hypermedia，即返回結(jié)果中提供鏈接架谎，連向其他API方法炸宵，使得用戶不查文檔，也知道下一步應(yīng)該做什么谷扣。
比如焙压，當(dāng)用戶向api.example.com的根目錄發(fā)出請(qǐng)求，會(huì)得到這樣一個(gè)文檔抑钟。
{"link": { "rel": "collection [https://www.example.com/zoos](https://www.example.com/zoos)", "href": "[https://api.example.com/zoos](https://api.example.com/zoos)", "title": "List of zoos", "type": "application/vnd.yourformat+json"}}
上面代碼表示涯曲，文檔中有一個(gè)link屬性，用戶讀取這個(gè)屬性就知道下一步該調(diào)用什么API了在塔。rel表示這個(gè)API與當(dāng)前網(wǎng)址的關(guān)系（collection關(guān)系幻件，并給出該collection的網(wǎng)址），href表示API的路徑蛔溃，title表示API的標(biāo)題绰沥，type表示返回類型。
Hypermedia API的設(shè)計(jì)被稱為HATEOAS贺待。Github的API就是這種設(shè)計(jì)徽曲，訪問api.github.com會(huì)得到一個(gè)所有可用API的網(wǎng)址列表。
{ "current_user_url": "[https://api.github.com/user](https://api.github.com/user)", "authorizations_url": "[https://api.github.com/authorizations](https://api.github.com/authorizations)", // ...}
從上面可以看到麸塞，如果想獲取當(dāng)前用戶的信息秃臣，應(yīng)該去訪問api.github.com/user，然后就得到了下面結(jié)果哪工。
{ "message": "Requires authentication", "documentation_url": "[https://developer.github.com/v3](https://developer.github.com/v3)"}
上面代碼表示奥此，服務(wù)器給出了提示信息，以及文檔的網(wǎng)址雁比。
十一稚虎、其他
（1）API的身份認(rèn)證應(yīng)該使用[OAuth 2.0](http://www.ruanyifeng.com/blog/2014/05/oauth_2_0.html)框架。
（2）服務(wù)器返回的數(shù)據(jù)格式偎捎，應(yīng)該盡量使用JSON蠢终，避免使用XML序攘。
