[非原創(chuàng)，原文鏈接]

API設(shè)計書籍下載：

　　1、keynote.pdf ?

　　2、api-design.pdf

最近在重構(gòu)公司的一個交互中間件，在重新設(shè)計API及總體架構(gòu)的時候思考了許多， 不禁萌發(fā)了一個疑問，什么樣的API才算是一個設(shè)計良好的API呢？

參考了許多的資料，做一下總結(jié)。主要來自這個keynote

什么是API

我們只要是在進行編程我們就需要不停的設(shè)計API，

API簡單來講可以是一個調(diào)用的函數(shù)，一個接口。抽象來說：接口是一個內(nèi)聚系統(tǒng)暴漏給外部的一切信息。 包含但不限于：

• 調(diào)用方式：比如通過lib庫或者http接口等
• 調(diào)用約定：比如lib的函數(shù)簽名或者HTTP的參數(shù)，http method或者頭信息，長短鏈接等等。
• 依賴關(guān)系：比如接口的調(diào)用需要涉及到第三方或者其他的準(zhǔn)備工作等等。

設(shè)計良好API的特點

這里探討的API均為系統(tǒng)邊界的API設(shè)計，而對于內(nèi)部API來說不在探討范圍之內(nèi)。

變動困難

API就像一個人一樣，我們和一個API打交道的時候需要了解這個人的特性偏好等， 有的人很好相處，而有的人讓人很頭疼，尤其是你不得不和他打交道的時候。

和人一樣，如果你不得不和他打交道，要改變他的秉性是很痛苦的，人的“本性難移”, API也一樣，一旦發(fā)布了，要改變的成本就很大很大。

好的API應(yīng)該具有：

易于學(xué)習(xí)

即使沒有文檔也易于使用

不易誤用：這一點很重要，要減少使用者的心智負擔(dān)

使用API的代碼易于維護。這個有點不一樣，不是API本身易于維護，而是API的友好度。 比如接口功能單一，使用簡單，使用者的代碼也會相應(yīng)的更易于維護

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

易于擴展

怎么樣設(shè)計良好的API

基本原則：

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

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

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

設(shè)計不被實現(xiàn)影響:不要暴漏實現(xiàn)細節(jié)給用戶

竟可能少的暴露，不止是內(nèi)部細節(jié)，對于不必要的接口盡量不要發(fā)布，比如使用不多的功能， 可以暫時不暴露接口。

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

完善的文檔

考慮性能

其他具體的方法還是參考后面參考資料的內(nèi)容吧。

參考資料

• http://mattgemmell.com/api-design/
• http://lcsd05.cs.tamu.edu/slides/keynote.pdf?
• http://ishare.iask.sina.com.cn/f/61717785.html
• http://qt-project.org/wiki/API-Design-Principles
• http://www4.in.tum.de/~blanchet/api-design.pdf

轉(zhuǎn)載于:https://www.cnblogs.com/gotodsp/p/3628038.html

總結(jié)

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

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。