在本系列關(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)]