如何定位好的API設(shè)計?

什么是API添吗?

我們只要是在進行編程我們就需要不停的設(shè)計API沥曹。

API簡單來講可以是一個調(diào)用的函數(shù),一個接口碟联。

抽象來說妓美,接口是一個內(nèi)聚系統(tǒng)暴漏給外部的一切信息,包含但不限于:

調(diào)用方式:比如通過lib庫或者http接口等鲤孵。

調(diào)用約定:比如lib的函數(shù)簽名或者HTTP的參數(shù)壶栋,http method或者頭信息,長短鏈接等等普监。

依賴關(guān)系:比如接口的調(diào)用需要涉及到第三方或者其他的準備工作等等贵试。

API就像一個人一樣,我們和一個API打交道的時候需要了解這個人的特性偏好等凯正,有的人很好相處毙玻,而有的人讓人很頭疼,尤其是你不得不和他打交道的時候漆际,和人一樣,如果你不得不和他打交道夺饲,要改變他的秉性是很痛苦的奸汇,人的“本性難移”, API也一樣,一旦發(fā)布了往声,要改變的成本就很大很大擂找。

好的API應(yīng)該具有:

易于學習:即使沒有文檔也易于使用。

不易誤用:這一點很重要浩销,要減少使用者的心智負擔贯涎。

易于滿足需求:API的完備性和正交性。能夠容易的滿足需求慢洋,完備性保證功能完整塘雳,正交性保證接口的簡潔性陆盘,不需要為所有的需求提供接口,而是由用戶去組合败明。

易于擴展性

怎么樣設(shè)計良好的API隘马?

專一:一個API的功能應(yīng)該是單一的,需要能夠很容易的解釋和理解妻顶,也就會更好用酸员。

盡可能的小:小有很多的優(yōu)勢讳嘱,易于理解和維護幔嗦。

盡量少的外部依賴:減少使用者的成本。

設(shè)計不被實現(xiàn)影響:不要暴漏實現(xiàn)細節(jié)給用戶沥潭,竟可能少的暴露邀泉,不止是內(nèi)部細節(jié),對于不必要的接口盡量不要發(fā)布叛氨,比如使用不多的功能呼渣,可以暫時不暴露接口。

良好的命名:盡量做到自描述寞埠。

完善的文檔

考慮性能

如果你覺得眼前需要更好的提高你可以來千鋒學PHP屁置,國內(nèi)最好的PHP機構(gòu)。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末仁连,一起剝皮案震驚了整個濱河市蓝角,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌饭冬,老刑警劉巖使鹅,帶你破解...
    沈念sama閱讀 216,470評論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異昌抠,居然都是意外死亡患朱,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,393評論 3 392
  • 文/潘曉璐 我一進店門炊苫,熙熙樓的掌柜王于貴愁眉苦臉地迎上來裁厅,“玉大人,你說我怎么就攤上這事侨艾≈春纾” “怎么了?”我有些...
    開封第一講書人閱讀 162,577評論 0 353
  • 文/不壞的土叔 我叫張陵唠梨,是天一觀的道長袋励。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么茬故? 我笑而不...
    開封第一講書人閱讀 58,176評論 1 292
  • 正文 為了忘掉前任盖灸,我火速辦了婚禮,結(jié)果婚禮上均牢,老公的妹妹穿的比我還像新娘糠雨。我一直安慰自己,他們只是感情好徘跪,可當我...
    茶點故事閱讀 67,189評論 6 388
  • 文/花漫 我一把揭開白布甘邀。 她就那樣靜靜地躺著,像睡著了一般垮庐。 火紅的嫁衣襯著肌膚如雪松邪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,155評論 1 299
  • 那天哨查,我揣著相機與錄音逗抑,去河邊找鬼。 笑死寒亥,一個胖子當著我的面吹牛邮府,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播溉奕,決...
    沈念sama閱讀 40,041評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼褂傀,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了加勤?” 一聲冷哼從身側(cè)響起仙辟,我...
    開封第一講書人閱讀 38,903評論 0 274
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎鳄梅,沒想到半個月后叠国,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,319評論 1 310
  • 正文 獨居荒郊野嶺守林人離奇死亡戴尸,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,539評論 2 332
  • 正文 我和宋清朗相戀三年粟焊,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片孙蒙。...
    茶點故事閱讀 39,703評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡项棠,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出马篮,到底是詐尸還是另有隱情沾乘,我是刑警寧澤怜奖,帶...
    沈念sama閱讀 35,417評論 5 343
  • 正文 年R本政府宣布浑测,位于F島的核電站,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏迁央。R本人自食惡果不足惜掷匠,卻給世界環(huán)境...
    茶點故事閱讀 41,013評論 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望岖圈。 院中可真熱鬧讹语,春花似錦、人聲如沸蜂科。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,664評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽导匣。三九已至才菠,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間贡定,已是汗流浹背赋访。 一陣腳步聲響...
    開封第一講書人閱讀 32,818評論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留缓待,地道東北人蚓耽。 一個月前我還...
    沈念sama閱讀 47,711評論 2 368
  • 正文 我出身青樓,卻偏偏與公主長得像旋炒,于是被迫代替她去往敵國和親步悠。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 44,601評論 2 353

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

  • 如何定位好的API設(shè)計 轉(zhuǎn)載2017-06-15 21:36:58 標簽:php 什么是API国葬? 我們只要是在進行...
    斯文小螞蟻閱讀 236評論 0 0
  • 什么是API汇四? 我們只要是在進行編程我們就需要不停的設(shè)計API接奈。 API簡單來講可以是一個調(diào)用的函數(shù),一個接口通孽。 ...
    小甲魚python閱讀 905評論 0 0
  • 什么是API背苦? 我們只要是在進行編程我們就需要不停的設(shè)計API互捌。 API簡單來講可以是一個調(diào)用的函數(shù),一個接口行剂。 ...
    新亮筆記閱讀 6,254評論 7 27
  • 最近各個學校都在進行期中考試厚宰,作為一名一線教師腌巾,我真的開始迷惑了: 1.讀題是不是一種能力遂填?2.孩子之間的差距到底...
    夏靨人間閱讀 255評論 0 0
  • 選擇太多,還是沒有選擇澈蝙。 這些都不重要吓坚,重要的是你要清楚自己的方向,自己的心灯荧。 秋天到了礁击,我的心還空著,你真的來嗎...
    艾尚萱閱讀 209評論 0 0