RESTful API?What is it?

REST全稱是Representational State Transfer,中文意思是表述性狀態(tài)轉(zhuǎn)移。不管是英文還是中文解釋,都難得其意!
那究竟指的是什么的表述? 其實指的就是資源。任何事物,只要有被引用到的必要,它就是一個資源。要讓一個資源可以被識別,需要有個唯一標識,在Web中這個唯一標識就是URI(Uniform Resource Identifier),標識的資源可能是服務器上的一個文件,不過,也可能是一個郵件地址、新聞消息、圖書、人名、Internet主機或者任何其它內(nèi)容。URI既可以看成是資源的地址,也可以看成是資源的名稱,它包含URL和URN。

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

一、URL 設計

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

1.賓語必須是名詞

賓語就是 API 的 URL,是 HTTP 動詞作用的對象。它應該是名詞,不能是動詞。

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

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

GET /articles
3.避免多級 URL

當資源需要多級分類時,比較好的做法是,除了第一級,其他級別都用查詢字符串表達。這種URL不僅利于擴展,語義也更加明確。

GET /articles?published=true

二、狀態(tài)碼

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

  • 以GET為例

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

三、服務器回應

1.不要返回純本文

API 返回的數(shù)據(jù)格式,不應該是純文本,而應該是一個 JSON 對象,因為這樣才能返回標準的結(jié)構(gòu)化數(shù)據(jù)。所以,服務器回應的 HTTP 頭的Content-Type屬性要設為application/json。
客戶端請求時,也要明確告訴服務器,可以接受 JSON 格式,即請求的 HTTP 頭的ACCEPT屬性也要設成application/json。

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

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

3.提供鏈接

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

HATEOAS(Hypermedia as the engine of application state),超媒體即應用狀態(tài)引擎。它是REST架構(gòu)的主要約束。“hepermedia”表示任何包含指向圖片、電影、文字等資源的鏈接,Web是超媒體的經(jīng)典例子。HATEOAS背后的思想其實非常簡單,就是響應中包含指向其它資源的鏈接??蛻舳丝梢岳眠@些鏈接和服務器交互。

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

————愿你在迷茫時,堅信你的珍貴,愛你所愛,行你所行,聽從你心,無問西東。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,505評論 6 533
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 98,556評論 3 418
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事?!?“怎么了?”我有些...
    開封第一講書人閱讀 176,463評論 0 376
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,009評論 1 312
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,778評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 55,218評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,281評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 42,436評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 48,969評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 40,795評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,993評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,537評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 44,229評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,659評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,917評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,687評論 3 392
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,990評論 2 374