RESTful API

RESTful API是什么

REST -- REpresentational State Transfer 即表現(xiàn)層狀態(tài)轉(zhuǎn)移,主要是為了設(shè)計(jì)合理的路徑來(lái)管理資源吊趾。REST API可以設(shè)計(jì)出更加簡(jiǎn)潔明了的接口,幫助實(shí)現(xiàn)系統(tǒng)之間的信息傳遞和調(diào)用關(guān)系躬贡。

RESTful API怎么用

REST簡(jiǎn)單說(shuō)為了實(shí)現(xiàn)為了獲取資源信息或?qū)ζ鋵?shí)施動(dòng)作的規(guī)范。從發(fā)出請(qǐng)求方式,到返回內(nèi)容格式非竿,以及動(dòng)作完成后資源。接下來(lái)將以獲取api的scope為例來(lái)總結(jié)所學(xué)內(nèi)容谋竖。

RESTful API就是你看到這個(gè)url就知道它是用來(lái)干嘛的红柱。其主要?jiǎng)幼饔性鰟h改查,如下表所示圈盔。


REST:Resource Representational State Transfer豹芯。即“資源”在網(wǎng)絡(luò)傳輸中以某種“表現(xiàn)形式”進(jìn)行“狀態(tài)轉(zhuǎn)移”。所涉及的這三點(diǎn)重點(diǎn)是:

資源:真實(shí)的對(duì)象數(shù)據(jù)驱敲。比如我們的api铁蹈,我們的app等等。

表現(xiàn)形式:資源的外在表現(xiàn)形式众眨,如json握牧,html, img等。

狀態(tài)轉(zhuǎn)移:資源的狀態(tài)娩梨,可以通過(guò)增刪改查引起資源狀態(tài)的改變沿腰。

路徑

路徑表示的是API的具體網(wǎng)址。這個(gè)網(wǎng)址中不能有動(dòng)詞狈定,只能有名詞颂龙,而且所用的名詞往往與數(shù)據(jù)庫(kù)的表格名對(duì)應(yīng)。一般來(lái)說(shuō)纽什,數(shù)據(jù)庫(kù)中的表都是同種記錄的"集合"(collection)措嵌,所以API中的名詞也應(yīng)該使用復(fù)數(shù)。

過(guò)濾信息

再進(jìn)行過(guò)濾信息的時(shí)候要注意資源的層次芦缰,比如想要獲取scope時(shí)企巢,因?yàn)閟cope是在api層級(jí)下的,所以要先寫apis/{apiName}/scopes(這個(gè)在第一次寫時(shí)寫成了/scopes/{apiName},當(dāng)時(shí)只考慮了用復(fù)數(shù)形式让蕾,忽略了層級(jí))浪规。

狀態(tài)碼

服務(wù)向用戶返回的狀態(tài)碼和信息一般有如下幾種:(參考文檔

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ù)器沒(méi)有進(jìn)行新建或修改數(shù)據(jù)的操作萌抵,該操作是冪等的。

401 Unauthorized - [*]:表示用戶沒(méi)有權(quán)限(令牌、用戶名绍填、密碼錯(cuò)誤)霎桅。

403 Forbidden - [*] 表示用戶得到授權(quán)(與401錯(cuò)誤相對(duì)),但是訪問(wèn)是被禁止的讨永。

404 NOT FOUND - [*]:用戶發(fā)出的請(qǐng)求針對(duì)的是不存在的記錄滔驶,服務(wù)器沒(méi)有進(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ò)誤吏口,用戶將無(wú)法判斷發(fā)出的請(qǐng)求是否成功。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末冰更,一起剝皮案震驚了整個(gè)濱河市产徊,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌蜀细,老刑警劉巖舟铜,帶你破解...
    沈念sama閱讀 219,188評(píng)論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異奠衔,居然都是意外死亡谆刨,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,464評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門归斤,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)痊夭,“玉大人,你說(shuō)我怎么就攤上這事官册。” “怎么了难捌?”我有些...
    開封第一講書人閱讀 165,562評(píng)論 0 356
  • 文/不壞的土叔 我叫張陵膝宁,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我根吁,道長(zhǎng)员淫,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,893評(píng)論 1 295
  • 正文 為了忘掉前任击敌,我火速辦了婚禮介返,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己圣蝎,他們只是感情好刃宵,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,917評(píng)論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著徘公,像睡著了一般牲证。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上关面,一...
    開封第一講書人閱讀 51,708評(píng)論 1 305
  • 那天坦袍,我揣著相機(jī)與錄音,去河邊找鬼等太。 笑死捂齐,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的缩抡。 我是一名探鬼主播奠宜,決...
    沈念sama閱讀 40,430評(píng)論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼缝其!你這毒婦竟也來(lái)了挎塌?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,342評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤内边,失蹤者是張志新(化名)和其女友劉穎榴都,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體漠其,經(jīng)...
    沈念sama閱讀 45,801評(píng)論 1 317
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡嘴高,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,976評(píng)論 3 337
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了和屎。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片拴驮。...
    茶點(diǎn)故事閱讀 40,115評(píng)論 1 351
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖柴信,靈堂內(nèi)的尸體忽然破棺而出套啤,到底是詐尸還是另有隱情,我是刑警寧澤随常,帶...
    沈念sama閱讀 35,804評(píng)論 5 346
  • 正文 年R本政府宣布潜沦,位于F島的核電站,受9級(jí)特大地震影響绪氛,放射性物質(zhì)發(fā)生泄漏唆鸡。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,458評(píng)論 3 331
  • 文/蒙蒙 一枣察、第九天 我趴在偏房一處隱蔽的房頂上張望争占。 院中可真熱鬧燃逻,春花似錦、人聲如沸臂痕。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,008評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)刻蟹。三九已至逗旁,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間舆瘪,已是汗流浹背片效。 一陣腳步聲響...
    開封第一講書人閱讀 33,135評(píng)論 1 272
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留英古,地道東北人淀衣。 一個(gè)月前我還...
    沈念sama閱讀 48,365評(píng)論 3 373
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像召调,于是被迫代替她去往敵國(guó)和親膨桥。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,055評(píng)論 2 355

推薦閱讀更多精彩內(nèi)容