如何定位好的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)。