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

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

轉(zhuǎn)載2017-06-15 21:36:58

標(biāo)簽:php

什么是API夭问?

我們只要是在進(jìn)行編程我們就需要不停的設(shè)計(jì)API月腋。

API簡(jiǎn)單來(lái)講可以是一個(gè)調(diào)用的函數(shù)咽白,一個(gè)接口数冬。

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

調(diào)用方式:比如通過(guò)lib庫(kù)或者h(yuǎn)ttp接口等配乱。

調(diào)用約定:比如lib的函數(shù)簽名或者HTTP的參數(shù)溉卓,http method或者頭信息,長(zhǎng)短鏈接等等搬泥。

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

API就像一個(gè)人一樣,我們和一個(gè)API打交道的時(shí)候需要了解這個(gè)人的特性偏好等佑钾,有的人很好相處西疤,而有的人讓人很頭疼烦粒,尤其是你不得不和他打交道的時(shí)候休溶,和人一樣,如果你不得不和他打交道扰她,要改變他的秉性是很痛苦的兽掰,人的“本性難移”, API也一樣,一旦發(fā)布了徒役,要改變的成本就很大很大孽尽。

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

易于學(xué)習(xí):即使沒(méi)有文檔也易于使用。

不易誤用:這一點(diǎn)很重要忧勿,要減少使用者的心智負(fù)擔(dān)杉女。

易于滿足需求:API的完備性和正交性瞻讽。能夠容易的滿足需求,完備性保證功能完整熏挎,正交性保證接口的簡(jiǎn)潔性速勇,不需要為所有的需求提供接口,而是由用戶去組合坎拐。

易于擴(kuò)展性

怎么樣設(shè)計(jì)良好的API烦磁?

專一:一個(gè)API的功能應(yīng)該是單一的,需要能夠很容易的解釋和理解哼勇,也就會(huì)更好用都伪。

盡可能的小:小有很多的優(yōu)勢(shì)积担,易于理解和維護(hù)陨晶。

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

設(shè)計(jì)不被實(shí)現(xiàn)影響:不要暴漏實(shí)現(xiàn)細(xì)節(jié)給用戶帝璧,竟可能少的暴露褥琐,不止是內(nèi)部細(xì)節(jié),對(duì)于不必要的接口盡量不要發(fā)布克伊,比如使用不多的功能皮官,可以暫時(shí)不暴露接口。

良好的命名:盡量做到自描述撮躁。

完善的文檔

考慮性能

如果你覺(jué)得眼前需要更好的提高你可以來(lái)千鋒學(xué)PHP漱病,國(guó)內(nèi)最好的PHP機(jī)構(gòu)。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末把曼,一起剝皮案震驚了整個(gè)濱河市杨帽,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌嗤军,老刑警劉巖注盈,帶你破解...
    沈念sama閱讀 222,729評(píng)論 6 517
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異叙赚,居然都是意外死亡老客,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 95,226評(píng)論 3 399
  • 文/潘曉璐 我一進(jìn)店門(mén)震叮,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)胧砰,“玉大人,你說(shuō)我怎么就攤上這事苇瓣∥炯洌” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 169,461評(píng)論 0 362
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)哲嘲。 經(jīng)常有香客問(wèn)我贪薪,道長(zhǎng),這世上最難降的妖魔是什么眠副? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 60,135評(píng)論 1 300
  • 正文 為了忘掉前任古掏,我火速辦了婚禮,結(jié)果婚禮上侦啸,老公的妹妹穿的比我還像新娘槽唾。我一直安慰自己,他們只是感情好光涂,可當(dāng)我...
    茶點(diǎn)故事閱讀 69,130評(píng)論 6 398
  • 文/花漫 我一把揭開(kāi)白布庞萍。 她就那樣靜靜地躺著,像睡著了一般忘闻。 火紅的嫁衣襯著肌膚如雪钝计。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書(shū)人閱讀 52,736評(píng)論 1 312
  • 那天齐佳,我揣著相機(jī)與錄音私恬,去河邊找鬼。 笑死炼吴,一個(gè)胖子當(dāng)著我的面吹牛本鸣,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播硅蹦,決...
    沈念sama閱讀 41,179評(píng)論 3 422
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼荣德,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了童芹?” 一聲冷哼從身側(cè)響起涮瞻,我...
    開(kāi)封第一講書(shū)人閱讀 40,124評(píng)論 0 277
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎假褪,沒(méi)想到半個(gè)月后署咽,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,657評(píng)論 1 320
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡生音,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,723評(píng)論 3 342
  • 正文 我和宋清朗相戀三年宁否,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片久锥。...
    茶點(diǎn)故事閱讀 40,872評(píng)論 1 353
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡家淤,死狀恐怖异剥,靈堂內(nèi)的尸體忽然破棺而出瑟由,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 36,533評(píng)論 5 351
  • 正文 年R本政府宣布歹苦,位于F島的核電站青伤,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏殴瘦。R本人自食惡果不足惜狠角,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 42,213評(píng)論 3 336
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望蚪腋。 院中可真熱鬧丰歌,春花似錦、人聲如沸屉凯。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 32,700評(píng)論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)悠砚。三九已至晓勇,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間灌旧,已是汗流浹背绑咱。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,819評(píng)論 1 274
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留枢泰,地道東北人描融。 一個(gè)月前我還...
    沈念sama閱讀 49,304評(píng)論 3 379
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像衡蚂,于是被迫代替她去往敵國(guó)和親稼稿。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,876評(píng)論 2 361

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