什麽是好的API設計？

今天又來到了吹批面試過程的時間了, 先說說:

什麽是API？

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

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

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

調用方式

比如通過lib庫或者http接口等。

調用約定

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

依賴關係

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

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

好的API應該具有：

易於學習

即使沒有文档也易於使用。

不易誤用

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

易於滿足需求

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

易於擴展性

...

怎麽樣設計良好的API？

專一

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

盡可能的小, 輕量級

小有很多的優勢，易於理解和維護。

盡量少的外部依賴

減少使用者的成本。

設計不被實現影響

不要暴漏實現細節給用戶，竟可能少的暴露，不止是内部細節，對於不必要的接口盡量不要發布，比如使用不多的功能，可以暫時不暴露接口。

良好的命名

盡量做到自描述。

完善的文档(特別是公司團隊項目)

考慮性能(聽起來像廢話, 但沒性能的接口咱好意思寫出去給人用嗎)