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