Restful是什么
- 本質(zhì)：一種軟件架構(gòu)風(fēng)格
- 核心：面向資源
- 資源：網(wǎng)絡(luò)上的一個(gè)實(shí)體，網(wǎng)絡(luò)上的一個(gè)具體信息
- 解決的問題：1、降低開發(fā)的復(fù)雜性；2、提高系統(tǒng)的可伸縮性
也可以總結(jié)為一句話：Restful是所有Web應(yīng)用都應(yīng)該遵守的架構(gòu)設(shè)計(jì)指導(dǎo)原則。
Restful中HTTP協(xié)議介紹
http協(xié)議-url
http是一個(gè)屬于應(yīng)用層的協(xié)議,特點(diǎn)是簡(jiǎn)捷、快速。
schema://host[:port]/path[?query-string][#anchor]
- ==scheme== 指定低層使用的的協(xié)議(例如：http,https,ftp)
- ==host== 服務(wù)器的IP地址或域名
- ==port== 服務(wù)器端口,默認(rèn)為80
- ==path== 訪問資源的路徑
- ==query-string== 發(fā)送給http服務(wù)器的數(shù)據(jù)
- ==anchor== 錨
http協(xié)議-請(qǐng)求
組成格式：請(qǐng)求行、消息報(bào)頭、請(qǐng)求報(bào)文
請(qǐng)求行
- 格式如下：Method Request-URL HTTP-Version CRLF
舉例
- GET / HTTP/1.1 CRLF
請(qǐng)求方法
- ==GET== 請(qǐng)求獲取Requesr-URI所標(biāo)識(shí)的資源
- ==POST== 在Request-URI所標(biāo)識(shí)的資源后附加薪的數(shù)據(jù)
- ==HEAD== 請(qǐng)求獲取由Request-URI所標(biāo)識(shí)的資源的響應(yīng)消息報(bào)頭
- ==PUT== 請(qǐng)求服務(wù)器存儲(chǔ)一個(gè)資源,并用Request-URI作為其標(biāo)識(shí)
- ==DELETE== 請(qǐng)求服務(wù)器刪除Request-URI所標(biāo)識(shí)的資源
- ==OPTIONS== 請(qǐng)求查詢服務(wù)器的性能,或者查詢與資源相關(guān)的選項(xiàng)和需求
http協(xié)議-響應(yīng)
組成格式：狀態(tài)行、消息報(bào)頭、響應(yīng)正文
狀態(tài)行
- HTTP-Version Status-Code Reason-Phrase CRLF
- 例如：HTTP /1.1 200 OK
常用狀態(tài)碼
- 200 OK //客戶端請(qǐng)求成功
- 400 Bad Request //客戶端請(qǐng)求有語法錯(cuò)誤，不能被服務(wù)器所理解
- 401 Unauthorized //服務(wù)器收到請(qǐng)求,但是拒絕提供服務(wù)
- 404 Not Found //請(qǐng)求資源不存在
- 500 Internal Server Error //服務(wù)器發(fā)送不可預(yù)期的錯(cuò)誤
- 503 Server Unavailable //服務(wù)器當(dāng)前不能處理客戶端的請(qǐng)求
Restful架構(gòu)與其他架構(gòu)的區(qū)別
SOAP WebService
- WebService是一種跨編程語言和跨操作系統(tǒng)平臺(tái)的遠(yuǎn)程調(diào)用技術(shù)。
- WebService通過HTTP協(xié)議發(fā)送請(qǐng)求和接收結(jié)果時(shí)采用XML格式封裝，并增加了一些特定的HTTP消息頭，這些特定的HTTP消息頭和XML內(nèi)容格式就是SOAP協(xié)議。
效率和易用性
- SOAP由于各種需求不斷擴(kuò)充其本身協(xié)議的內(nèi)容，導(dǎo)致在SOAP處理方面的性能有所下降。同時(shí)在易用性方面以及學(xué)習(xí)成本上也有所
增加。 - Restful由于其面向資源接口設(shè)計(jì)以及操作抽象簡(jiǎn)化了開發(fā)者的不良設(shè)計(jì)，同時(shí)也最大限度
的利用了Http最初的應(yīng)用協(xié)議設(shè)計(jì)理念。
安全性
- Restful對(duì)于資源型服務(wù)接口來說很合適，同時(shí)特別適合對(duì)于效率要求很高，但是對(duì)于安全要求不高的場(chǎng)景。
- SOAP的成熟性可以給需要提供給多開發(fā)語言的，對(duì)于安全性要求較高的接口設(shè)計(jì)帶來便利。所以我覺得純粹說什么設(shè)計(jì)模式將會(huì)占據(jù)主導(dǎo)地位沒有什么意義，關(guān)鍵還是看應(yīng)用場(chǎng)景。
如何設(shè)計(jì)Restful API
協(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)址。
HTTP其他
- API的身份認(rèn)證應(yīng)該使用OAuth 2.0框架。
- 服務(wù)器返回的數(shù)據(jù)格式，應(yīng)該盡量使用JSON，避免使用XML。
參考資料
Restful API實(shí)戰(zhàn)
RESTful API 設(shè)計(jì)指南
理解RESTful架構(gòu)
RESTful API 設(shè)計(jì)參考文獻(xiàn)列表
