什么是好的API設計？

mudiyouyou 發布于2019-06-27 14:14 / 2896人閱讀

摘要：什么是我們只要是在進行編程我們就需要不停的設計。不易誤用這一點很重要，要減少使用者的心智負擔。盡量少的外部依賴減少使用者的成本。良好的命名盡量做到自描述。

什么是API？

我們只要是在進行編程我們就需要不停的設計API。

API簡單來講可以是一個調用的函數，一個接口。

抽象來說，接口是一個內聚系統暴漏給外部的一切信息，包含但不限于：

調用方式：比如通過lib庫或者http接口等。

調用約定：比如lib的函數簽名或者HTTP的參數，http method或者頭信息，長短鏈接等等。

依賴關系：比如接口的調用需要涉及到第三方或者其他的準備工作等等。

API就像一個人一樣，我們和一個API打交道的時候需要了解這個人的特性偏好等，有的人很好相處，而有的人讓人很頭疼，尤其是你不得不和他打交道的時候，和人一樣，如果你不得不和他打交道，要改變他的秉性是很痛苦的，人的“本性難移”, API也一樣，一旦發布了，要改變的成本就很大很大。

好的API應該具有：

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

不易誤用：這一點很重要，要減少使用者的心智負擔。

易于滿足需求：API的完備性和正交性。能夠容易的滿足需求，完備性保證功能完整，正交性保證接口的簡潔性，不需要為所有的需求提供接口，而是由用戶去組合。

易于擴展性

怎么樣設計良好的API？

專一：一個API的功能應該是單一的，需要能夠很容易的解釋和理解，也就會更好用。

盡可能的小：小有很多的優勢，易于理解和維護。

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

設計不被實現影響：不要暴漏實現細節給用戶，竟可能少的暴露，不止是內部細節，對于不必要的接口盡量不要發布，比如使用不多的功能，可以暫時不暴露接口。

良好的命名：盡量做到自描述。

完善的文檔

考慮性能

Thanks ~

AD:

云服務器 GPU云服務器什么是好域名好的網站設計公司 api設計比較好的網站設計

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/21877.html

一篇文章了解Js Bridge

摘要：安全安全是很重要的，現在有些實現中使用了，而在之前，存在任意代碼執行漏洞，這就會導致嚴重的安全問題。 showImg(https://segmentfault.com/img/bV4k9Q?w=719&h=372); 什么是JS Bridge 在大多數APP開發過程中，都會通過H5來實現部分功能，而Hybird APP基本90%以上都是H5。現在很少有純原生的APP。但是，由于H5頁面...

Karuru 2019-08-22 14:54 評論0 收藏0
JavaScript文章

摘要：我對知乎前端相關問題的十問十答張鑫旭張鑫旭大神對知乎上經典的個前端問題的回答。作者對如何避免常見的錯誤，難以發現的問題，以及性能問題和不好的實踐給出了相應的建議。但并不是本身有問題，被標準定義的是極好的。這一次，徹底弄懂 JavaScript 執行機制本文的目的就是要保證你徹底弄懂javascript的執行機制，如果讀完本文還不懂，可以揍我。不論你是javascript新手還是老...

mumumu 2019-08-22 13:50 評論0 收藏0
why nodejs

摘要：一個快速計算假設每個線程可能有一個伴隨的內存，運行在具有的系統上，我們理論上最多有個并發連接，以及線程之間的上下文切換的成本。通過避免這一切，實現了超過個并發連接的可伸縮性級別作為概念驗證。通過近期的面試，我認識到自己的學習方法還是有問題，面百度的時候面試官問我，為什么要用node，為什么不用php，對于只學過node幾天的我當時就楞了，大概想到單線程事件輪詢和多線程，后來面試官告訴...

wujl596 2019-08-22 10:40 評論0 收藏0
《從零構建前后分離web項目》探究 - 深入聊聊前后分離架構

摘要：什么是前后分離前后端分離并不是什么新鮮事，到處都是前后端分離的實踐。然而一些歷史項目在從一體化設計轉向前后端分離的架構時，不可避免的會遇到各種各樣的問題。搞了一個前后分離，需要分離部署。探究：深入聊聊前后分離架構前后分離，一直是一個相當泛泛的問題，前后分離到底好不好？沒有絕對的對，沒有絕對的錯，業界就這個問題已經激烈的探討幾年了.出現討論的點在于：分離當然是好的,但是以什么樣的服...

whinc 2019-08-23 11:44 評論0 收藏0