轉(zhuǎn)自：RESTful API 設(shè)計(jì)指南-- 阮一峰

網(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ì)理論帆喇。

一、協(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)粘室。一般來說，數(shù)據(jù)庫(kù)中的表都是同種記錄的"集合"（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：指定第幾頁(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)碼和提示信息，常見的有以下一些（方括號(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":"collectionhttps://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暑竟。

（完）