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)信你的珍貴斋泄,愛你所愛,行你所行镐牺,聽從你心炫掐,無問西東。