RESTful API 設(shè)計(jì)規(guī)范

一個(gè)架構(gòu)符合REST(REpresentational State Transfer)原則凹蜈,就稱它為RESTful架構(gòu)俏拱。

資源 (Resources)

URI (Uniform Resource Identifiers) 統(tǒng)一資源標(biāo)示符

URI = scheme "://" authority "/" path [ "?" query ] [ "#" fragment ]

URI規(guī)范:

  • URI不包含動(dòng)詞从隆,使用名詞復(fù)數(shù)。
  • URI不使用大寫。
  • URI層級不要太深逻炊。

URL(Uniform Resource Locator) 統(tǒng)一資源定位符(URI的實(shí)現(xiàn))

對于REST API來說一個(gè)資源對應(yīng)一個(gè)唯一的URI(URL)

表現(xiàn)(Representation)

HTTP請求的頭信息中,用Accept和Content-Type標(biāo)示犁享。

狀態(tài)轉(zhuǎn)化(State Transfer)

  • GET:獲取資源
    GET /zoos
    GET /zoos/1
    GET /zoos/1/employees
    GET /zoos/1/employeessortby=name&order=asc

  • POST:新建資源(也可以更新資源)
    POST /animals 新增動(dòng)物
    POST /zoos/1/employees 新增動(dòng)物園1雇員

  • PUT:更新單個(gè)資源 全量更新
    PUT /animals/1
    PUT /zoos/1

  • DELETE:刪除資源
    DELETE /zoos/1/animals //刪除id為1的動(dòng)物園內(nèi)的所有動(dòng)物

常見異常返回碼

  • 400 bad request 常用在參數(shù)校驗(yàn)
  • 401 unauthorized 未經(jīng)驗(yàn)證的用戶余素,常見于未登錄。如果經(jīng)過驗(yàn)證后依然沒權(quán)限炊昆,應(yīng)該 403(即 authentication 和 authorization 的區(qū)別)桨吊。
  • 403 forbidden 無權(quán)限
  • 404 not found 資源不存在
  • 500 internal server error 代碼邏輯錯(cuò)誤導(dǎo)致,比如數(shù)據(jù)庫連接失敗凤巨、空指針異常视乐、除0錯(cuò)誤

異步任務(wù)

由于互聯(lián)網(wǎng)通信 高延時(shí)(high latency)、高并發(fā)等特點(diǎn) 異步任務(wù)派上大用場敢茁。

  1. 先返回任務(wù)創(chuàng)建成功
  2. 客戶端輪詢?nèi)蝿?wù)狀態(tài)

規(guī)范是提高效率的利器

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末佑淀,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子彰檬,更是在濱河造成了極大的恐慌伸刃,老刑警劉巖,帶你破解...
    沈念sama閱讀 221,635評論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件逢倍,死亡現(xiàn)場離奇詭異捧颅,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)瓶堕,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,543評論 3 399
  • 文/潘曉璐 我一進(jìn)店門隘道,熙熙樓的掌柜王于貴愁眉苦臉地迎上來症歇,“玉大人郎笆,你說我怎么就攤上這事⊥睿” “怎么了宛蚓?”我有些...
    開封第一講書人閱讀 168,083評論 0 360
  • 文/不壞的土叔 我叫張陵,是天一觀的道長设塔。 經(jīng)常有香客問我凄吏,道長,這世上最難降的妖魔是什么闰蛔? 我笑而不...
    開封第一講書人閱讀 59,640評論 1 296
  • 正文 為了忘掉前任痕钢,我火速辦了婚禮,結(jié)果婚禮上序六,老公的妹妹穿的比我還像新娘任连。我一直安慰自己,他們只是感情好例诀,可當(dāng)我...
    茶點(diǎn)故事閱讀 68,640評論 6 397
  • 文/花漫 我一把揭開白布随抠。 她就那樣靜靜地躺著裁着,像睡著了一般。 火紅的嫁衣襯著肌膚如雪拱她。 梳的紋絲不亂的頭發(fā)上二驰,一...
    開封第一講書人閱讀 52,262評論 1 308
  • 那天,我揣著相機(jī)與錄音秉沼,去河邊找鬼桶雀。 笑死,一個(gè)胖子當(dāng)著我的面吹牛唬复,可吹牛的內(nèi)容都是我干的背犯。 我是一名探鬼主播,決...
    沈念sama閱讀 40,833評論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼盅抚,長吁一口氣:“原來是場噩夢啊……” “哼漠魏!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起妄均,我...
    開封第一講書人閱讀 39,736評論 0 276
  • 序言:老撾萬榮一對情侶失蹤柱锹,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后丰包,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體禁熏,經(jīng)...
    沈念sama閱讀 46,280評論 1 319
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,369評論 3 340
  • 正文 我和宋清朗相戀三年邑彪,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了瞧毙。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,503評論 1 352
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡寄症,死狀恐怖宙彪,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情有巧,我是刑警寧澤释漆,帶...
    沈念sama閱讀 36,185評論 5 350
  • 正文 年R本政府宣布,位于F島的核電站篮迎,受9級特大地震影響男图,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜甜橱,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,870評論 3 333
  • 文/蒙蒙 一逊笆、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧岂傲,春花似錦难裆、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,340評論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽命锄。三九已至,卻和暖如春偏化,著一層夾襖步出監(jiān)牢的瞬間脐恩,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,460評論 1 272
  • 我被黑心中介騙來泰國打工侦讨, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留驶冒,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 48,909評論 3 376
  • 正文 我出身青樓韵卤,卻偏偏與公主長得像骗污,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個(gè)殘疾皇子沈条,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,512評論 2 359

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

  • 前言 網(wǎng)絡(luò)應(yīng)用程序需忿,分為前端和后端兩個(gè)部分。當(dāng)前的發(fā)展趨勢蜡歹,就是前端設(shè)備層出不窮(手機(jī)屋厘、平板、桌面電腦月而、其他專用設(shè)...
    小白frankie閱讀 438評論 0 1
  • 一說到REST汗洒,我想大家的第一反應(yīng)就是“啊,就是那種前后臺通信方式父款∫绨”但是在要求詳細(xì)講述它所提出的各個(gè)約束,以及如...
    時(shí)待吾閱讀 3,433評論 0 19
  • API定義規(guī)范 本規(guī)范設(shè)計(jì)基于如下使用場景: 請求頻率不是非常高:如果產(chǎn)品的使用周期內(nèi)請求頻率非常高憨攒,建議使用雙通...
    有涯逐無涯閱讀 2,557評論 0 6
  • 簡介 zabbix是一個(gè)基于WEB界面的提供分布式系統(tǒng)監(jiān)視以及網(wǎng)絡(luò)監(jiān)視功能的企業(yè)級的開源解決方案世杀。zabbix能監(jiān)...
    guo的學(xué)習(xí)筆記閱讀 2,226評論 0 1
  • 父母教練分享內(nèi)容包括但不限于: 本周目標(biāo)完成情況? 學(xué)習(xí):學(xué)會玉米娃浓恶、6-10 生活:堅(jiān)持早起早睡玫坛,睡前清單和清晨...
    caoxixi閱讀 205評論 0 0