RESTful API

什么是RESTful API ?

REST與技術(shù)無關(guān)杏慰,代表的是一種軟件架構(gòu)風(fēng)格浅碾,REST是Representational State Transfer的簡稱,中文翻譯為“表征狀態(tài)轉(zhuǎn)移”或“表現(xiàn)層狀態(tài)轉(zhuǎn)化”割择。

什么是URI和URL?

URI統(tǒng)一的資源標(biāo)志符
URL統(tǒng)一的資源定位符
URI是給我們的資源進(jìn)行標(biāo)識的介劫,URL是描述我們資源地址的。

REST風(fēng)格的特點(diǎn):

  1. 在web中,只要有被引用的必要都叫資源.

2.每個(gè)URI代表一個(gè)資源,獨(dú)一無二的.

  1. 客戶端通過HTTP的方法,對服務(wù)器端的資源進(jìn)行操作.

  2. 客戶端和服務(wù)器之間,傳遞這種資源的某種表層.

  3. 通過超鏈接的指引,實(shí)現(xiàn)"表現(xiàn)層轉(zhuǎn)態(tài)轉(zhuǎn)移".

RESTFUL規(guī)范

面向資源編程

每個(gè)URL代表一種資源,URL中盡量不要用動詞,要用名詞.

根據(jù)methond不同,進(jìn)行不同的操作

GET? : 從一個(gè)服務(wù)器取出資源(一項(xiàng)或多項(xiàng))
POST?: 從一個(gè)服務(wù)器新建一個(gè)資源
PUT :在服務(wù)器更新資源(客戶端提供改變后的完整資源)
PATCH :在服務(wù)器更新資源(客戶端提供改變的屬性)
DELETE :從服務(wù)器刪除資源

過濾

通過在url上傳參的形式傳遞搜索條件

https://api.example.com/v1/zoos?limit=10:指定返回記錄的數(shù)量

https://api.example.com/v1/zoos?offset=10:指定返回記錄的開始位置

https://api.example.com/v1/zoos?page=2&per_page=100:指定第幾頁痢艺,以及每頁的記錄數(shù)

https://api.example.com/v1/zoos?sortby=name&order=asc:指定返回結(jié)果按照哪個(gè)屬性排序,以及排序順序

https://api.example.com/v1/zoos?animal_type_id=1:指定篩選條件

狀態(tài)碼

200 OK - [GET]:服務(wù)器成功返回用戶請求的數(shù)據(jù)介陶,該操作是冪等的(Idempotent)堤舒。
201 CREATED - [POST/PUT/PATCH]:用戶新建或修改數(shù)據(jù)成功。
202 Accepted - [*]:表示一個(gè)請求已經(jīng)進(jìn)入后臺排隊(duì)(異步任務(wù))
204 NO CONTENT - [DELETE]:用戶刪除數(shù)據(jù)成功哺呜。
400 INVALID REQUEST - [POST/PUT/PATCH]:用戶發(fā)出的請求有錯(cuò)誤舌缤,服務(wù)器沒有進(jìn)行新建或修改數(shù)據(jù)的操作,該操作是冪等的某残。
401 Unauthorized - [*]:表示用戶沒有權(quán)限(令牌国撵、用戶名、密碼錯(cuò)誤)玻墅。
403 Forbidden - [*] 表示用戶得到授權(quán)(與401錯(cuò)誤相對)介牙,但是訪問是被禁止的。
404 NOT FOUND - [*]:用戶發(fā)出的請求針對的是不存在的記錄澳厢,服務(wù)器沒有進(jìn)行操作环础,該操作是冪等的。
406 Not Acceptable - [GET]:用戶請求的格式不可得(比如用戶請求JSON格式剩拢,但是只有XML格式)线得。
410 Gone -[GET]:用戶請求的資源被永久刪除,且不會再得到的徐伐。
422 Unprocesable entity - [POST/PUT/PATCH] 當(dāng)創(chuàng)建一個(gè)對象時(shí)贯钩,發(fā)生一個(gè)驗(yàn)證錯(cuò)誤。
500 INTERNAL SERVER ERROR - [*]:服務(wù)器發(fā)生錯(cuò)誤,用戶將無法判斷發(fā)出的請求是否成功角雷。

錯(cuò)誤處理

狀態(tài)碼是4xx時(shí)祸穷,應(yīng)返回錯(cuò)誤信息,error當(dāng)做key谓罗。

{
    error: "Invalid API key"
}

Hypermedia API

如果遇到需要跳轉(zhuǎn)的情況 攜帶調(diào)轉(zhuǎn)接口的URL

 ret = {
                code: 1000,
                data:{
                    id:1,
                    name:'小強(qiáng)',
                    depart_id:https://www.4399.com
                }
            }
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末粱哼,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子檩咱,更是在濱河造成了極大的恐慌揭措,老刑警劉巖,帶你破解...
    沈念sama閱讀 219,270評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件刻蚯,死亡現(xiàn)場離奇詭異绊含,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)炊汹,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,489評論 3 395
  • 文/潘曉璐 我一進(jìn)店門躬充,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人讨便,你說我怎么就攤上這事充甚。” “怎么了霸褒?”我有些...
    開封第一講書人閱讀 165,630評論 0 356
  • 文/不壞的土叔 我叫張陵伴找,是天一觀的道長。 經(jīng)常有香客問我废菱,道長技矮,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,906評論 1 295
  • 正文 為了忘掉前任殊轴,我火速辦了婚禮衰倦,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘旁理。我一直安慰自己樊零,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,928評論 6 392
  • 文/花漫 我一把揭開白布孽文。 她就那樣靜靜地躺著淹接,像睡著了一般。 火紅的嫁衣襯著肌膚如雪叛溢。 梳的紋絲不亂的頭發(fā)上塑悼,一...
    開封第一講書人閱讀 51,718評論 1 305
  • 那天,我揣著相機(jī)與錄音楷掉,去河邊找鬼厢蒜。 笑死霞势,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的斑鸦。 我是一名探鬼主播愕贡,決...
    沈念sama閱讀 40,442評論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼巷屿!你這毒婦竟也來了固以?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,345評論 0 276
  • 序言:老撾萬榮一對情侶失蹤嘱巾,失蹤者是張志新(化名)和其女友劉穎憨琳,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體旬昭,經(jīng)...
    沈念sama閱讀 45,802評論 1 317
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡篙螟,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,984評論 3 337
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了问拘。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片遍略。...
    茶點(diǎn)故事閱讀 40,117評論 1 351
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖骤坐,靈堂內(nèi)的尸體忽然破棺而出绪杏,到底是詐尸還是另有隱情,我是刑警寧澤纽绍,帶...
    沈念sama閱讀 35,810評論 5 346
  • 正文 年R本政府宣布寞忿,位于F島的核電站,受9級特大地震影響顶岸,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜叫编,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,462評論 3 331
  • 文/蒙蒙 一辖佣、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧搓逾,春花似錦卷谈、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,011評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至朗兵,卻和暖如春污淋,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背余掖。 一陣腳步聲響...
    開封第一講書人閱讀 33,139評論 1 272
  • 我被黑心中介騙來泰國打工寸爆, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 48,377評論 3 373
  • 正文 我出身青樓赁豆,卻偏偏與公主長得像仅醇,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個(gè)殘疾皇子魔种,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,060評論 2 355

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

  • RESTful架構(gòu) 互聯(lián)網(wǎng)軟件:即網(wǎng)站析二,一種新型的軟件,采用客戶端/服務(wù)器模式节预,建立在分布式體系上叶摄,通過互聯(lián)網(wǎng)通信...
    零一_fb4d閱讀 299評論 0 0
  • 目錄 定義(Definitions) 數(shù)據(jù)的設(shè)計(jì)與抽象化(Data Design and Abstraction)...
    55lover閱讀 2,088評論 0 4
  • 一、API API -- Application Programming Interface心铃,即應(yīng)用程序編程接口准谚。...
    AlleniCode閱讀 470評論 0 0
  • 轉(zhuǎn)載自 http://www.cnblogs.com/moonz-wu/p/4211626.html 做出一個(gè)好的...
    啟艦科技閱讀 3,079評論 0 5
  • 文章導(dǎo)讀: 網(wǎng)絡(luò)應(yīng)用程序,分為前端和后端兩個(gè)部分去扣。當(dāng)前的發(fā)展趨勢柱衔,就是前端設(shè)備層出不窮(手機(jī)、平板愉棱、桌面電腦唆铐、其他...
    創(chuàng)造new_world閱讀 279評論 0 0