資訊專欄INFORMATION COLUMN
摘要：什么是我們只要是在進(jìn)行編程我們就需要不停的設(shè)計(jì)。不易誤用這一點(diǎn)很重要，要減少使用者的心智負(fù)擔(dān)。盡量少的外部依賴減少使用者的成本。良好的命名盡量做到自描述。
什么是API？
我們只要是在進(jìn)行編程我們就需要不停的設(shè)計(jì)API。
API簡單來講可以是一個調(diào)用的函數(shù)，一個接口。
抽象來說，接口是一個內(nèi)聚系統(tǒng)暴漏給外部的一切信息，包含但不限于：
調(diào)用方式：比如通過lib庫或者h(yuǎn)ttp接口等。
調(diào)用約定：比如lib的函數(shù)簽名或者HTTP的參數(shù)，http method或者頭信息，長短鏈接等等。
依賴關(guān)系：比如接口的調(diào)用需要涉及到第三方或者其他的準(zhǔn)備工作等等。
API就像一個人一樣，我們和一個API打交道的時候需要了解這個人的特性偏好等，有的人很好相處，而有的人讓人很頭疼，尤其是你不得不和他打交道的時候，和人一樣，如果你不得不和他打交道，要改變他的秉性是很痛苦的，人的“本性難移”, API也一樣，一旦發(fā)布了，要改變的成本就很大很大。
好的API應(yīng)該具有：
易于學(xué)習(xí)：即使沒有文檔也易于使用。
不易誤用：這一點(diǎn)很重要，要減少使用者的心智負(fù)擔(dān)。
易于滿足需求：API的完備性和正交性。能夠容易的滿足需求，完備性保證功能完整，正交性保證接口的簡潔性，不需要為所有的需求提供接口，而是由用戶去組合。
易于擴(kuò)展性
怎么樣設(shè)計(jì)良好的API？
專一：一個API的功能應(yīng)該是單一的，需要能夠很容易的解釋和理解，也就會更好用。
盡可能的?。盒∮泻芏嗟膬?yōu)勢，易于理解和維護(hù)。
盡量少的外部依賴：減少使用者的成本。
設(shè)計(jì)不被實(shí)現(xiàn)影響：不要暴漏實(shí)現(xiàn)細(xì)節(jié)給用戶，竟可能少的暴露，不止是內(nèi)部細(xì)節(jié)，對于不必要的接口盡量不要發(fā)布，比如使用不多的功能，可以暫時不暴露接口。
良好的命名：盡量做到自描述。
完善的文檔
考慮性能
Thanks ~
AD:
文章版權(quán)歸作者所有，未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請注明本文地址：http://systransis.cn/yun/21877.html
摘要：安全安全是很重要的，現(xiàn)在有些實(shí)現(xiàn)中使用了，而在之前，存在任意代碼執(zhí)行漏洞，這就會導(dǎo)致嚴(yán)重的安全問題。 showImg(https://segmentfault.com/img/bV4k9Q?w=719&h=372); 什么是JS Bridge 在大多數(shù)APP開發(fā)過程中，都會通過H5來實(shí)現(xiàn)部分功能，而Hybird APP基本90%以上都是H5?，F(xiàn)在很少有純原生的APP。但是，由于H5頁面...
摘要：我對知乎前端相關(guān)問題的十問十答張鑫旭張鑫旭大神對知乎上經(jīng)典的個前端問題的回答。作者對如何避免常見的錯誤，難以發(fā)現(xiàn)的問題，以及性能問題和不好的實(shí)踐給出了相應(yīng)的建議。但并不是本身有問題，被標(biāo)準(zhǔn)定義的是極好的。 這一次，徹底弄懂 JavaScript 執(zhí)行機(jī)制 本文的目的就是要保證你徹底弄懂javascript的執(zhí)行機(jī)制，如果讀完本文還不懂，可以揍我。 不論你是javascript新手還是老...
摘要：一個快速計(jì)算假設(shè)每個線程可能有一個伴隨的內(nèi)存，運(yùn)行在具有的系統(tǒng)上，我們理論上最多有個并發(fā)連接，以及線程之間的上下文切換的成本。通過避免這一切，實(shí)現(xiàn)了超過個并發(fā)連接的可伸縮性級別作為概念驗(yàn)證。 通過近期的面試，我認(rèn)識到自己的學(xué)習(xí)方法還是有問題，面百度的時候面試官問我，為什么要用node，為什么不用php，對于只學(xué)過node幾天的我當(dāng)時就楞了，大概想到單線程事件輪詢和多線程，后來面試官告訴...
摘要：什么是前后分離前后端分離并不是什么新鮮事，到處都是前后端分離的實(shí)踐。然而一些歷史項(xiàng)目在從一體化設(shè)計(jì)轉(zhuǎn)向前后端分離的架構(gòu)時，不可避免的會遇到各種各樣的問題。搞了一個前后分離，需要分離部署。 探究 ：深入聊聊前后分離架構(gòu) 前后分離，一直是一個相當(dāng)泛泛的問題，前后分離到底好不好？沒有絕對的對，沒有絕對的錯，業(yè)界就這個問題已經(jīng)激烈的探討幾年了.出現(xiàn)討論的點(diǎn)在于：分離當(dāng)然是好的,但是以什么樣的服...
閱讀 2003·2021-11-19 09:40
閱讀 1963·2021-09-28 09:36
閱讀 2296·2021-09-22 10:02
閱讀 2738·2019-08-30 14:00
閱讀 1967·2019-08-29 15:31
閱讀 2908·2019-08-29 15:11
閱讀 2916·2019-08-29 13:04
閱讀 1090·2019-08-27 10:55
