前言 本篇博文來自一次公司內部的前端分享,從多個方面討論了在設計接口時遵循的原則,總共包含了七個大塊。系鹵煮自己總結的一些經驗和教訓。本篇博文同時也參考了其他一些文章,相關地址會在后面貼出來。很難做到詳盡充實,如果有好的建議或者不對的地方,還望不吝賜教斧正。 一、接口的流暢性 好的接口是流暢 ...
在郵件列表和討論區中有很多與REST和Web API相關的討論,下面僅是我個人對這些問題的一些見解,並沒有絕對的真理,InnoQ的首席顧問Oliver Wolf在GOTO Berlin大會上開始自己的演講 Web API設計原則 時如是說。 不要考慮端點。SOAP有一個單獨入口點的外觀。相比之下Web有很多入口點,它們建立在關系上,彼此之間相互連接,並且以超媒體作為關鍵要素。為了不讓你的API成為 ...
2013-10-23 06:24 0 2517 推薦指數:
前言 本篇博文來自一次公司內部的前端分享,從多個方面討論了在設計接口時遵循的原則,總共包含了七個大塊。系鹵煮自己總結的一些經驗和教訓。本篇博文同時也參考了其他一些文章,相關地址會在后面貼出來。很難做到詳盡充實,如果有好的建議或者不對的地方,還望不吝賜教斧正。 一、接口的流暢性 好的接口是流暢 ...
RESTful API設計原則與規范 一、背景與基礎概念 2 二、RESTful API應遵循的原則 3 1、協議(Protocol) 3 2、域名(ROOT URL) 3 3、版本(Versioning) 3 4、路徑(Endpoints) 3 5、HTTP動詞 ...
背景 第一次聽說 SPI 是閱讀《軟件框架設計的藝術》,以后陸續在 Log4Net 和 Quartz.Net中發現了以這種形式組織代碼的方式,本位給出為什么要區分 SPI 和 API 的一個思考過程。 從面向接口編程說起 我們在“調用方”和“實現方”之間引入了“接口”,上圖沒有給出“接口 ...
RESTful API的設計原則 Good API design is hard! An API represe ...
轉載自一位大佬 英文原版 Principles of good RESTful API Design Good API design is hard! An API represents a contract between you and those who Consume your data. ...
1、在接口定義中確定MVC的GET或者POST方式 由於我們整個Web API平台是基於MVC的基礎上進行的API開發,因此整個Web API的接口,在定義的時候,一般需要顯示來聲明接口是[HttpGet]或者[HttpPost],雖然有些接口也可以不用聲明,但是避免出現類似下面 ...
摘要 在之前的幾篇文章中,我們從如何實現最簡單的HTTP服務器,到如何對路由進行改進,到如何增加中間件。總的來講,我們已經把Web服務器相關的內容大概梳理了一遍了。在這一篇文章中,我們將從最簡單的一個main函數開始,慢慢重構,來研究如何把API設計的更加規范和具有擴展性。 1 構建一個Web ...
原文作者Mathieu Fenniak在博文中大呼:不要再設計易碎的Web API 了,否則你的合作伙伴或第三方開發者會因此恨你,而離你遠去的。他認為,想設計出相對穩定、牢固的API,關鍵在於以應用目的為中心。文中還分享了設計優秀API需要注意的幾點事項,我們一起來看下: 如果破壞了API,客戶 ...