什么是API？

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

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

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

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

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

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

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

好的API應該具有：

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

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

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

• 易于擴展性

怎么樣設計良好的API？

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

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

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

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

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

• 完善的文檔

• 考慮性能

---

Thanks ~

AD:

總結

以上是生活随笔為你收集整理的什么是好的API设计？的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。