什麼是好的API設計？

什麼是API？

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

API簡單來說能夠是一個調用的函數，一個接口。

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

• 調用方式：好比經過lib庫或者http接口等。

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

• 依賴關係：好比接口的調用須要涉及到第三方或者其餘的準備工做等等。

API就像一我的同樣，咱們和一個API打交道的時候須要瞭解這我的的特性偏好等，有的人很好相處，而有的人讓人很頭疼，尤爲是你不得不和他打交道的時候，和人同樣，若是你不得不和他打交道，要改變他的秉性是很痛苦的，人的「本性難移」, API也同樣，一旦發佈了，要改變的成本就很大很大。

好的API應該具備：

• 易於學習：即便沒有文檔也易於使用。

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

• 易於知足需求：API的完備性和正交性。可以容易的知足需求，完備性保證功能完整，正交性保證接口的簡潔性，不須要爲全部的需求提供接口，而是由用戶去組合。

• 易於擴展性

怎麼樣設計良好的API？

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

• 儘量的小：小有不少的優點，易於理解和維護。

• 儘可能少的外部依賴：減小使用者的成本。

• 設計不被實現影響：不要暴漏實現細節給用戶，竟可能少的暴露，不止是內部細節，對於沒必要要的接口儘可能不要發佈，好比使用很少的功能，能夠暫時不暴露接口。

• 良好的命名：儘可能作到自描述。

• 完善的文檔

• 考慮性能

---

Thanks ~

AD: