網(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è)概念蔚万。

一岭妖、協(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", "href": "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", "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徐钠。