優秀API設計的十大原則

每個軟件開發人員都使用API。“優秀”的API設計就像魔法。不過，我不知道有多少人可以解釋為什么有的API很復雜、很難學，而有的則干凈、簡單、使用起來堪稱是一種快樂。關于這個問題，我將在文中回答，并提供優秀API設計的十條法則。

api-logo

1.只做你今天需要的

這是最頂級的規則。只解決今天必須解決的問題，最小化需要完成的答案。解決明天的問題的誘惑力是巨大的。但是一定要頂住誘惑！不要提前發布代碼，重點是注重縮小發布周期。如果需要花幾個小時的時間來回答新問題，那么就不用再猜測明天會出現什么問題了。

2.API模塊化

將大型問題轉化為規模較小的、可單獨解決的問題。模塊化API更容易學習，并且可以隨時間而改變。你可以用新模塊替代舊模塊。可以一個一個地教導模塊。也可以將API的實驗部分從穩定或傳統的部分中單獨分出來。

3.使用結構化語法

使用結構化的API語法：用thing.action或thing.property代替do_action_with_thing。語法將自然而然地適應模塊化的方法，其中每個模塊是一個類。

4.使用自然語義

不要發明新概念。只使用開發人員眾所周知的概念，作為類系統的基礎。如果你發現自己需要解釋概念，那說明你出錯了：要么你在解決以后的問題，要么你正在錯誤地構建API。

5.API的自我約定

每個類都要嚴格使用相同的樣式和約定。一致性是指當一個人學會這一個類時，他就能夠融會貫通地掌握全部的類。文檔化約定，讓它們成為貢獻者必須的標準。

6.API的可擴展性

易擴展性有許多好處，并不僅僅在于受到貢獻者的歡迎。它還可以讓你延緩實現功能，因為“如果需要的話，后面再添加也很方便”。不需要的功能就不添加，這也是一種雙贏。

7.完全測試

每個類和方法必須經過惡意代碼的完全測試。要像寫代碼一樣寫測試，然后像API提供給外界約定文檔一樣使用測試。每當代碼改變的時候就運行這些測試。不要擔心代碼覆蓋率。重要的是外部約定。也可以考慮使用約定生命周期。

8.分層式成長

保持API突出重點，然后在頂部將新的API分層，以便于它們能隨著時間的推移成長。可擴展性并不意味著無限期的成長。明確API的范圍，并在范圍內執行。

9.保持簡單易用

最終的測試要看API的簡單易用程度。你寫的例子，能不能讓你的代碼看起來更簡單？你是不是強迫用戶說明他們不在乎的選項？有沒有毫無價值的額外步驟？要注重約減少API的可視面積。

10.保持可移植性

不要讓系統概念泄漏到API。整潔有目的地抽象：這個API可以運行在任何操作系統上。API必須能夠隱藏實現，但要注意第4條規則，以及要使用自然抽象。

歡迎大家說說自己的看法。