RESTful API 設(shè)計(jì)之錯誤處理

原文地址

在本系列關(guān)于實(shí)用 REST API 設(shè)計(jì)的前幾篇文章中炊豪,我談到了簡單的關(guān)聯(lián),使用HTTP? 來隱藏復(fù)雜性和可選參數(shù),選擇復(fù)數(shù)名詞和具體名稱等等傍衡。 查看完整系列

RESTful API 錯誤處理的最佳實(shí)踐呢负蠕? 包括我自己在內(nèi)的許多軟件開發(fā)人員并不總是喜歡考慮異常和錯誤處理蛙埂,但這對任何軟件開發(fā)人員來說都是一個非常重要的難題,特別是對于 API 設(shè)計(jì)人員來說虐急。

為什么好的錯誤處理設(shè)計(jì)對于 API 設(shè)計(jì)者來說尤其重要?

最重要的是箱残,讓你的 API 變得直觀并讓開發(fā)人員更有效率。

首先止吁,開發(fā)人員通過錯誤來修改代碼被辑。 極限編程和更新的“測試驅(qū)動開發(fā)”模型的“測試優(yōu)先”概念代表了一系列最佳實(shí)踐,因?yàn)檫@對于開發(fā)人員來說是非常重要和自然的工作方式敬惦。

從開發(fā)人員使用 Web API 的角度來看盼理,該接口另一端的所有內(nèi)容都是黑盒子。 錯誤因此成為提供關(guān)于如何使用 API 的上下文和可見性的關(guān)鍵工具俄删。

其次宏怔,除了在開發(fā)應(yīng)用程序時,開發(fā)人員在關(guān)鍵時刻依靠設(shè)計(jì)良好的錯誤進(jìn)行故障排除和解決問題畴椰,而這些問題是在他們使用 API 構(gòu)建的應(yīng)用程序掌握在用戶手中之后臊诊。

如何在 REST 中以實(shí)用的方式思考錯誤

讓我們來看看三個頂級API如何接近它。

[圖片上傳失敗...(image-8c8d85-1524561897915)]

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末斜脂,一起剝皮案震驚了整個濱河市抓艳,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌帚戳,老刑警劉巖玷或,帶你破解...
    沈念sama閱讀 212,816評論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異片任,居然都是意外死亡偏友,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,729評論 3 385
  • 文/潘曉璐 我一進(jìn)店門对供,熙熙樓的掌柜王于貴愁眉苦臉地迎上來位他,“玉大人,你說我怎么就攤上這事±庥眨” “怎么了泼橘?”我有些...
    開封第一講書人閱讀 158,300評論 0 348
  • 文/不壞的土叔 我叫張陵,是天一觀的道長迈勋。 經(jīng)常有香客問我炬灭,道長,這世上最難降的妖魔是什么靡菇? 我笑而不...
    開封第一講書人閱讀 56,780評論 1 285
  • 正文 為了忘掉前任重归,我火速辦了婚禮,結(jié)果婚禮上厦凤,老公的妹妹穿的比我還像新娘鼻吮。我一直安慰自己,他們只是感情好较鼓,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,890評論 6 385
  • 文/花漫 我一把揭開白布椎木。 她就那樣靜靜地躺著,像睡著了一般博烂。 火紅的嫁衣襯著肌膚如雪香椎。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 50,084評論 1 291
  • 那天禽篱,我揣著相機(jī)與錄音畜伐,去河邊找鬼。 笑死躺率,一個胖子當(dāng)著我的面吹牛玛界,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播悼吱,決...
    沈念sama閱讀 39,151評論 3 410
  • 文/蒼蘭香墨 我猛地睜開眼慎框,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了后添?” 一聲冷哼從身側(cè)響起鲤脏,我...
    開封第一講書人閱讀 37,912評論 0 268
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎吕朵,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體窥突,經(jīng)...
    沈念sama閱讀 44,355評論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡努溃,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,666評論 2 327
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了阻问。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片梧税。...
    茶點(diǎn)故事閱讀 38,809評論 1 341
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出第队,到底是詐尸還是另有隱情哮塞,我是刑警寧澤,帶...
    沈念sama閱讀 34,504評論 4 334
  • 正文 年R本政府宣布凳谦,位于F島的核電站忆畅,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏尸执。R本人自食惡果不足惜家凯,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 40,150評論 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望如失。 院中可真熱鬧绊诲,春花似錦、人聲如沸褪贵。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,882評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽脆丁。三九已至世舰,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間偎快,已是汗流浹背冯乘。 一陣腳步聲響...
    開封第一講書人閱讀 32,121評論 1 267
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留晒夹,地道東北人裆馒。 一個月前我還...
    沈念sama閱讀 46,628評論 2 362
  • 正文 我出身青樓,卻偏偏與公主長得像丐怯,于是被迫代替她去往敵國和親喷好。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,724評論 2 351

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

  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 171,867評論 25 707
  • 一說到REST读跷,我想大家的第一反應(yīng)就是“啊梗搅,就是那種前后臺通信方式⌒Ю溃”但是在要求詳細(xì)講述它所提出的各個約束无切,以及如...
    時待吾閱讀 3,417評論 0 19
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn)丐枉,斷路器哆键,智...
    卡卡羅2017閱讀 134,638評論 18 139
  • 有時候你會發(fā)現(xiàn)大學(xué)考試就是這么任性 我們開卷考考學(xué)生手冊 隔壁的舍友有份答案 然而我不幸的發(fā)現(xiàn)書里很多和答案有入 ...
    就靜靜聽你說閱讀 143評論 0 0
  • 祖輩風(fēng)雨路 后世家國魂 多難興邦易 萬古中華情
    光影腹黑閱讀 308評論 0 0