前言:最近兩年很火爆的網(wǎng)絡(luò)框架Retrofit务嫡,使用它的時(shí)候甲抖,查看文檔會(huì)告訴你漆改,要求后臺(tái)的服務(wù)器哥們必須符合REST規(guī)范給你設(shè)計(jì)接口,作為安卓開發(fā)工程師來說准谚,我就很奇怪了挫剑,REST規(guī)范到底是啥?本著極客精神氛魁,我就查了資料暮顺,寫了這么一篇文章,如果有不對(duì)的地方秀存,歡迎提意見捶码。
本文轉(zhuǎn)載自:http://www.ruanyifeng.com/blog/2014/05/restful_api.html
一、理解RESTful架構(gòu)
越來越多的人開始意識(shí)到或链,網(wǎng)站即軟件惫恼,而且是一種新型的軟件。
這種"互聯(lián)網(wǎng)軟件"采用客戶端/服務(wù)器模式澳盐,建立在分布式體系上祈纯,通過互聯(lián)網(wǎng)通信,具有高延時(shí)(high latency)叼耙、高并發(fā)等特點(diǎn)腕窥。
網(wǎng)站開發(fā),完全可以采用軟件開發(fā)的模式筛婉。但是傳統(tǒng)上,軟件和網(wǎng)絡(luò)是兩個(gè)不同的領(lǐng)域爽撒,很少有交集;軟件開發(fā)主要針對(duì)單機(jī)環(huán)境硕勿,網(wǎng)絡(luò)則主要研究系統(tǒng)之間的通信哨毁《笸剩互聯(lián)網(wǎng)的興起,使得這兩個(gè)領(lǐng)域開始融合抄沮,** 現(xiàn)在我們必須考慮,如何開發(fā)在互聯(lián)網(wǎng)環(huán)境中使用的軟件刻伊。**
RESTful架構(gòu),就是目前最流行的一種互聯(lián)網(wǎng)軟件架構(gòu)。它結(jié)構(gòu)清晰、符合標(biāo)準(zhǔn)愧怜、易于理解渴逻、擴(kuò)展方便惨奕,所以正得到越來越多網(wǎng)站的采用卧波。
但是港粱,到底什么是RESTful架構(gòu)寸宏,并不是一個(gè)容易說清楚的問題罩阵。下面鞋仍,我就談?wù)勎依斫獾腞ESTful架構(gòu)溃斋。
一、起源
REST這個(gè)詞走哺,是Roy Thomas Fielding在他2000年的博士論文中提出的废恋。
Fielding是一個(gè)非常重要的人,他是HTTP協(xié)議(1.0版和1.1版)的主要設(shè)計(jì)者隔披、Apache服務(wù)器軟件的作者之一、Apache基金會(huì)的第一任主席。所以,他的這篇論文一經(jīng)發(fā)表揩魂,就引起了關(guān)注没炒,并且立即對(duì)互聯(lián)網(wǎng)開發(fā)產(chǎn)生了深遠(yuǎn)的影響犯戏。
他這樣介紹論文的寫作目的:
本文研究計(jì)算機(jī)科學(xué)兩大前沿----軟件和網(wǎng)絡(luò)----的交叉點(diǎn)送火。長(zhǎng)期以來,軟件研究主要關(guān)注軟件設(shè)計(jì)的分類先匪、設(shè)計(jì)方法的演化种吸,很少客觀地評(píng)估不同的設(shè)計(jì)選擇對(duì)系統(tǒng)行為的影響。而相反地呀非,網(wǎng)絡(luò)研究主要關(guān)注系統(tǒng)之間通信行為的細(xì)節(jié)坚俗、如何改進(jìn)特定通信機(jī)制的表現(xiàn),常常忽視了一個(gè)事實(shí)岸裙,那就是改變應(yīng)用程序的互動(dòng)風(fēng)格比改變互動(dòng)協(xié)議猖败,對(duì)整體表現(xiàn)有更大的影響。我這篇文章的寫作目的哥桥,就是想在符合架構(gòu)原理的前提下辙浑,理解和評(píng)估以網(wǎng)絡(luò)為基礎(chǔ)的應(yīng)用軟件的架構(gòu)設(shè)計(jì),得到一個(gè)功能強(qiáng)拟糕、性能好判呕、適宜通信的架構(gòu)。
二送滞、名稱
Fielding將他對(duì)互聯(lián)網(wǎng)軟件的架構(gòu)原則侠草,定名為REST,即Representational State Transfer的縮寫犁嗅。我對(duì)這個(gè)詞組的翻譯是"表現(xiàn)層狀態(tài)轉(zhuǎn)化"边涕。
如果一個(gè)架構(gòu)符合REST原則,就稱它為RESTful架構(gòu)褂微。
要理解RESTful架構(gòu)功蜓,最好的方法就是去理解Representational State Transfer這個(gè)詞組到底是什么意思,它的每一個(gè)詞代表了什么涵義宠蚂。如果你把這個(gè)名稱搞懂了式撼,也就不難體會(huì)REST是一種什么樣的設(shè)計(jì)。
三求厕、資源(Resources)
REST的名稱"表現(xiàn)層狀態(tài)轉(zhuǎn)化"中著隆,省略了主語扰楼。"表現(xiàn)層"其實(shí)指的是"資源"(Resources)的"表現(xiàn)層"。
所謂"資源"美浦,就是網(wǎng)絡(luò)上的一個(gè)實(shí)體弦赖,或者說是網(wǎng)絡(luò)上的一個(gè)具體信息。它可以是一段文本浦辨、一張圖片蹬竖、一首歌曲、一種服務(wù)流酬,總之就是一個(gè)具體的實(shí)在案腺。你可以用一個(gè)URI(統(tǒng)一資源標(biāo)識(shí)符)指向它,每種資源對(duì)應(yīng)一個(gè)特定的URI康吵。要獲取這個(gè)資源,訪問它的URI就可以访递,因此URI就成了每一個(gè)資源的地址或獨(dú)一無二的識(shí)別符晦嵌。
附:
URI:Uniform Resource Identifier,統(tǒng)一資源標(biāo)識(shí)符
URL:Uniform Resource Location統(tǒng)一資源定位符
所謂"上網(wǎng)"拷姿,就是與互聯(lián)網(wǎng)上一系列的"資源"互動(dòng)惭载,調(diào)用它的URI。
四响巢、表現(xiàn)層(Representation)
"資源"是一種信息實(shí)體描滔,它可以有多種外在表現(xiàn)形式。我們把"資源"具體呈現(xiàn)出來的形式踪古,叫做它的"表現(xiàn)層"(Representation)含长。
比如,文本可以用txt格式表現(xiàn)伏穆,也可以用HTML格式拘泞、XML格式、JSON格式表現(xiàn)枕扫,甚至可以采用二進(jìn)制格式陪腌;圖片可以用JPG格式表現(xiàn),也可以用PNG格式表現(xiàn)烟瞧。
URI只代表資源的實(shí)體诗鸭,不代表它的形式。嚴(yán)格地說参滴,有些網(wǎng)址最后的".html"后綴名是不必要的强岸,因?yàn)檫@個(gè)后綴名表示格式,屬于"表現(xiàn)層"范疇卵洗,而URI應(yīng)該只代表"資源"的位置请唱。它的具體表現(xiàn)形式弥咪,應(yīng)該在HTTP請(qǐng)求的頭信息中用Accept和Content-Type字段指定,這兩個(gè)字段才是對(duì)"表現(xiàn)層"的描述十绑。
五聚至、狀態(tài)轉(zhuǎn)化(State Transfer)
訪問一個(gè)網(wǎng)站,就代表了客戶端和服務(wù)器的一個(gè)互動(dòng)過程本橙。在這個(gè)過程中扳躬,勢(shì)必涉及到數(shù)據(jù)和狀態(tài)的變化。
互聯(lián)網(wǎng)通信協(xié)議HTTP協(xié)議甚亭,是一個(gè)無狀態(tài)協(xié)議贷币。這意味著,所有的狀態(tài)都保存在服務(wù)器端亏狰。因此役纹,如果客戶端想要操作服務(wù)器,必須通過某種手段暇唾,讓服務(wù)器端發(fā)生"狀態(tài)轉(zhuǎn)化"(State Transfer)促脉。而這種轉(zhuǎn)化是建立在表現(xiàn)層之上的,所以就是"表現(xiàn)層狀態(tài)轉(zhuǎn)化"策州。
客戶端用到的手段瘸味,只能是HTTP協(xié)議。具體來說够挂,就是HTTP協(xié)議里面旁仿,四個(gè)表示操作方式的動(dòng)詞:GET、POST孽糖、PUT枯冈、DELETE。它們分別對(duì)應(yīng)四種基本操作:GET用來獲取資源梭姓,POST用來新建資源(也可以用于更新資源)霜幼,PUT用來更新資源,DELETE用來刪除資源誉尖。
六罪既、綜述
綜合上面的解釋,我們總結(jié)一下什么是RESTful架構(gòu):
≌∷ (1)每一個(gè)URI代表一種資源琢感;
(2)客戶端和服務(wù)器之間探熔,傳遞這種資源的某種表現(xiàn)層驹针;
(3)客戶端通過四個(gè)HTTP動(dòng)詞诀艰,對(duì)服務(wù)器端資源進(jìn)行操作柬甥,實(shí)現(xiàn)"表現(xiàn)層狀態(tài)轉(zhuǎn)化"饮六。
七、誤區(qū)
RESTful架構(gòu)有一些典型的設(shè)計(jì)誤區(qū)苛蒲。
最常見的一種設(shè)計(jì)錯(cuò)誤卤橄,就是URI包含動(dòng)詞。因?yàn)?資源"表示一種實(shí)體臂外,所以應(yīng)該是名詞窟扑,URI不應(yīng)該有動(dòng)詞,動(dòng)詞應(yīng)該放在HTTP協(xié)議中漏健。
舉例來說嚎货,某個(gè)URI是/posts/show/1,其中show是動(dòng)詞蔫浆,這個(gè)URI就設(shè)計(jì)錯(cuò)了殖属,正確的寫法應(yīng)該是/posts/1,然后用GET方法表示show瓦盛。
如果某些動(dòng)作是HTTP動(dòng)詞表示不了的忱辅,你就應(yīng)該把動(dòng)作做成一種資源。比如網(wǎng)上匯款谭溉,從賬戶1向賬戶2匯款500元,錯(cuò)誤的URI是:
POST /accounts/1/transfer/500/to/2
正確的寫法是把動(dòng)詞transfer改成名詞transaction橡卤,資源不能是動(dòng)詞扮念,但是可以是一種服務(wù):
POST /transaction HTTP/1.1
Host: 127.0.0.1
from=1&to=2&amount=500.00
另一個(gè)設(shè)計(jì)誤區(qū),就是在URI中加入版本號(hào):
http://www.example.com/app/1.0/foo
http://www.example.com/app/1.1/foo
http://www.example.com/app/2.0/foo
因?yàn)椴煌陌姹颈炭猓梢岳斫獬赏环N資源的不同表現(xiàn)形式柜与,所以應(yīng)該采用同一個(gè)URI。版本號(hào)可以在HTTP請(qǐng)求頭信息的Accept字段中進(jìn)行區(qū)分(參見Versioning REST Services):
Accept: vnd.example-com.foo+json; version=1.0
Accept: vnd.example-com.foo+json; version=1.1
Accept: vnd.example-com.foo+json; version=2.0
二嵌灰、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ì)理論蚊惯。我以前寫過一篇《理解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ù)庫(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:指定第幾頁恕酸,以及每頁的記錄數(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筹麸。
(完)