RESTful API?What is it?

REST全稱是Representational State Transfer削罩,中文意思是表述性狀態(tài)轉(zhuǎn)移瞄勾。不管是英文還是中文解釋,都難得其意弥激!
那究竟指的是什么的表述? 其實(shí)指的就是資源丰榴。任何事物,只要有被引用到的必要秆撮,它就是一個資源四濒。要讓一個資源可以被識別,需要有個唯一標(biāo)識职辨,在Web中這個唯一標(biāo)識就是URI(Uniform Resource Identifier)盗蟆,標(biāo)識的資源可能是服務(wù)器上的一個文件,不過舒裤,也可能是一個郵件地址喳资、新聞消息、圖書腾供、人名仆邓、Internet主機(jī)或者任何其它內(nèi)容鲜滩。URI既可以看成是資源的地址,也可以看成是資源的名稱节值,它包含URL和URN徙硅。

  • URL = Universal Resource Locator 統(tǒng)一資源定位符
    URL唯一地標(biāo)識一個資源在Internet上的位置。不管用什么方法表示搞疗,只要能定位一個資源嗓蘑,就叫URL。
  • URN = Universal Resource Name 統(tǒng)一資源名稱
    URN它命名資源但不指定如何定位資源匿乃,比如:只告訴你一個人的姓名桩皿,不告訴你這個人在哪。

一幢炸、URL 設(shè)計(jì)

RESTful 的核心思想就是泄隔,客戶端發(fā)出的數(shù)據(jù)操作指令都是"動詞 + 賓語"的結(jié)構(gòu)。簡單來說就是URL定位資源宛徊,用HTTP動詞描述操作佛嬉。
比如用GET來表示讀取,POST表示新建岩调,PUT表示更新巷燥,PATCH表示更新,但通常是部分更新号枕,DELETE表示刪除缰揪。

1.賓語必須是名詞

賓語就是 API 的 URL,是 HTTP 動詞作用的對象葱淳。它應(yīng)該是名詞钝腺,不能是動詞。

GET /article
2.復(fù)數(shù) URL

沒有統(tǒng)一的規(guī)定赞厕,但是常見的操作是當(dāng)要讀取一個集合要用復(fù)數(shù)形式艳狐。

GET /articles
3.避免多級 URL

當(dāng)資源需要多級分類時,比較好的做法是皿桑,除了第一級毫目,其他級別都用查詢字符串表達(dá)。這種URL不僅利于擴(kuò)展诲侮,語義也更加明確镀虐。

GET /articles?published=true

二、狀態(tài)碼

狀態(tài)碼表示必須明確
  • 通常來說:1xx表示相關(guān)信息沟绪,2xx表示操作成功刮便,3xx表示重定向,4xx表示客戶端錯誤绽慈,5xx表示服務(wù)器錯誤恨旱。RESTful就要求將這五類按不同請求方式進(jìn)行細(xì)分辈毯。

  • 以GET為例

200(OK)——表示已在響應(yīng)中發(fā)出
204(無內(nèi)容) —— 資源有空表示
301(Moved Permanently) —— 資源的URI已被更新
303(See Other) —— 其他(如,負(fù)載均衡)
304(not modified)—— 資源未更改(緩存)
400 (bad request)—— 指代壞請求(如搜贤,參數(shù)錯誤)
404 (not found)—— 資源不存在
406 (not acceptable)—— 服務(wù)端不支持所需表示
500 (internal server error)—— 通用錯誤響應(yīng)
503 (Service Unavailable)—— 服務(wù)端當(dāng)前無法處理請求

三谆沃、服務(wù)器回應(yīng)

1.不要返回純本文

API 返回的數(shù)據(jù)格式,不應(yīng)該是純文本入客,而應(yīng)該是一個 JSON 對象管毙,因?yàn)檫@樣才能返回標(biāo)準(zhǔn)的結(jié)構(gòu)化數(shù)據(jù)腿椎。所以桌硫,服務(wù)器回應(yīng)的 HTTP 頭的Content-Type屬性要設(shè)為application/json。
客戶端請求時啃炸,也要明確告訴服務(wù)器铆隘,可以接受 JSON 格式,即請求的 HTTP 頭的ACCEPT屬性也要設(shè)成application/json南用。

2.發(fā)生錯誤時膀钠,不要返回 200 狀態(tài)碼

狀態(tài)碼反映發(fā)生的錯誤,并將具體的錯誤信息放在數(shù)據(jù)體里面返回裹虫。在發(fā)生錯誤時也返回200狀態(tài)碼肿嘲,這種做法是不恰當(dāng)?shù)摹?/p>

3.提供鏈接

在回應(yīng)中,給出相關(guān)鏈接筑公,便于下一步操作雳窟。這樣的話,用戶只要記住一個 URL匣屡,就可以發(fā)現(xiàn)其他的 URL封救。這種方法叫做 HATEOAS。

HATEOAS(Hypermedia as the engine of application state)捣作,超媒體即應(yīng)用狀態(tài)引擎誉结。它是REST架構(gòu)的主要約束∪辏“hepermedia”表示任何包含指向圖片惩坑、電影、文字等資源的鏈接也拜,Web是超媒體的經(jīng)典例子以舒。HATEOAS背后的思想其實(shí)非常簡單,就是響應(yīng)中包含指向其它資源的鏈接搪泳∠」欤客戶端可以利用這些鏈接和服務(wù)器交互。

超媒體是什么?
當(dāng)你瀏覽Web網(wǎng)頁時岸军,從一個連接跳到一個頁面奋刽,再從另一個連接跳到另外一個頁面瓦侮,就是利用了超媒體的概念:把一個個把資源鏈接起來。
要達(dá)到這個目的佣谐,就要求在表述格式里邊加入鏈接來引導(dǎo)客戶端肚吏。在《RESTful Web Services》一書中,作者把這種具有鏈接的特性成為連通性狭魂。
這一特性應(yīng)用特別廣泛罚攀,比如創(chuàng)建訂單后通過鏈接引導(dǎo)客戶端如何去付款。

————愿你在迷茫時雌澄,堅(jiān)信你的珍貴斋泄,愛你所愛,行你所行镐牺,聽從你心炫掐,無問西東。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末睬涧,一起剝皮案震驚了整個濱河市募胃,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌畦浓,老刑警劉巖痹束,帶你破解...
    沈念sama閱讀 212,332評論 6 493
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異讶请,居然都是意外死亡祷嘶,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,508評論 3 385
  • 文/潘曉璐 我一進(jìn)店門秽梅,熙熙樓的掌柜王于貴愁眉苦臉地迎上來抹蚀,“玉大人,你說我怎么就攤上這事企垦』啡溃” “怎么了?”我有些...
    開封第一講書人閱讀 157,812評論 0 348
  • 文/不壞的土叔 我叫張陵钞诡,是天一觀的道長郑现。 經(jīng)常有香客問我,道長荧降,這世上最難降的妖魔是什么接箫? 我笑而不...
    開封第一講書人閱讀 56,607評論 1 284
  • 正文 為了忘掉前任,我火速辦了婚禮朵诫,結(jié)果婚禮上辛友,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好废累,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,728評論 6 386
  • 文/花漫 我一把揭開白布邓梅。 她就那樣靜靜地躺著,像睡著了一般邑滨。 火紅的嫁衣襯著肌膚如雪日缨。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,919評論 1 290
  • 那天掖看,我揣著相機(jī)與錄音匣距,去河邊找鬼。 笑死哎壳,一個胖子當(dāng)著我的面吹牛毅待,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播耳峦,決...
    沈念sama閱讀 39,071評論 3 410
  • 文/蒼蘭香墨 我猛地睜開眼恩静,長吁一口氣:“原來是場噩夢啊……” “哼焕毫!你這毒婦竟也來了蹲坷?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,802評論 0 268
  • 序言:老撾萬榮一對情侶失蹤邑飒,失蹤者是張志新(化名)和其女友劉穎循签,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體疙咸,經(jīng)...
    沈念sama閱讀 44,256評論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡县匠,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,576評論 2 327
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了撒轮。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片乞旦。...
    茶點(diǎn)故事閱讀 38,712評論 1 341
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖题山,靈堂內(nèi)的尸體忽然破棺而出兰粉,到底是詐尸還是另有隱情,我是刑警寧澤顶瞳,帶...
    沈念sama閱讀 34,389評論 4 332
  • 正文 年R本政府宣布玖姑,位于F島的核電站,受9級特大地震影響慨菱,放射性物質(zhì)發(fā)生泄漏焰络。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 40,032評論 3 316
  • 文/蒙蒙 一符喝、第九天 我趴在偏房一處隱蔽的房頂上張望闪彼。 院中可真熱鬧,春花似錦协饲、人聲如沸畏腕。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,798評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽郊尝。三九已至二跋,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間流昏,已是汗流浹背扎即。 一陣腳步聲響...
    開封第一講書人閱讀 32,026評論 1 266
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留况凉,地道東北人谚鄙。 一個月前我還...
    沈念sama閱讀 46,473評論 2 360
  • 正文 我出身青樓,卻偏偏與公主長得像刁绒,于是被迫代替她去往敵國和親闷营。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,606評論 2 350