網(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 API的設(shè)計(jì)細(xì)節(jié)抚岗，探討如何設(shè)計(jì)一套合理、好用的API纹份。

RESTful ,一種軟件架構(gòu)風(fēng)格苟跪、設(shè)計(jì)風(fēng)格，而不是標(biāo)準(zhǔn)蔓涧，只是提供了一組設(shè)計(jì)原則和約束條件件已。它主要用于客戶端和服務(wù)器交互類的軟件≡基于這個(gè)風(fēng)格設(shè)計(jì)的軟件可以更簡(jiǎn)潔篷扩，更有層次，更易于實(shí)現(xiàn)緩存等機(jī)制茉盏。REST 指的是一組架構(gòu)約束條件和原則鉴未。滿足這些約束條件和原則的應(yīng)用程序或設(shè)計(jì)就是 RESTful。

一鸠姨、協(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ù)庫(kù)的表格名對(duì)應(yīng)饲趋。一般來(lái)說(shuō)拐揭，數(shù)據(jù)庫(kù)中的表都是同種記錄的”集合”（collection），所以API中的名詞也應(yīng)該使用復(fù)數(shù)奕塑。

舉例來(lái)說(shuō)堂污，有一個(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)物

六旷偿、過(guò)濾信息（Filtering）

如果記錄數(shù)量很多，服務(wù)器不可能都將它們返回給用戶。API應(yīng)該提供參數(shù)狸捅，過(guò)濾返回結(jié)果衷蜓。

下面是一些常見(jiàn)的參數(shù)。

?limit=10：指定返回記錄的數(shù)量

?offset=10：指定返回記錄的開(kāi)始位置尘喝。

?page=2&per_page=100：指定第幾頁(yè)磁浇，以及每頁(yè)的記錄數(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)碼和提示信息戴质，常見(jiàn)的有以下一些（方括號(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ù)器沒(méi)有進(jìn)行新建或修改數(shù)據(jù)的操作，該操作是冪等的输莺。

401 Unauthorized – [*]：表示用戶沒(méi)有權(quán)限（令牌戚哎、用戶名、密碼錯(cuò)誤）嫂用。

403 Forbidden – [*] 表示用戶得到授權(quán)（與401錯(cuò)誤相對(duì)）型凳，但是訪問(wèn)是被禁止的。

404 NOT FOUND – [*]：用戶發(fā)出的請(qǐng)求針對(duì)的是不存在的記錄尸折，服務(wù)器沒(méi)有進(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ò)誤缴淋，用戶將無(wú)法判斷發(fā)出的請(qǐng)求是否成功准给。

狀態(tài)碼的完全列表參見(jiàn)這里泄朴。

八、錯(cuò)誤處理（Error handling）

如果狀態(tài)碼是4xx露氮，就應(yīng)該向用戶返回出錯(cuò)信息祖灰。一般來(lái)說(shuō)，返回的信息中將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ì)伐坏，訪問(wèn)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)該去訪問(wèn)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贷掖。