優秀API設計的十大原則—兄弟連IT教育

來源:互聯網
上載者:User
優秀API設計的十大原則—兄弟連IT教育
每個軟體開發人員都使用API。“優秀”的API設計就像魔法。不過,我不知道有多少人可以解釋為什麼有的API很複雜、很難學,而有的則乾淨、簡單、使用起來堪稱是一種快樂。關於這個問題,我將在文中回答,並提供優秀API設計的十條法則。
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條規則,以及要使用自然抽象。
免費領取LAMP兄弟連原創PHP視頻教程光碟片/《細說PHP》精要版,詳情諮詢官網客服:
http://www.lampbrother.net
【兄弟連IT教育】學PHP、Linux、HTML5、UI、Android等視頻教程(課件+筆記+視頻)!
網盤教程下載:http://pan.baidu.com/s/1mg8ANMg

以上就介紹了優秀API設計的十大原則—兄弟連IT教育,包括了方面的內容,希望對PHP教程有興趣的朋友有所協助。

  • 聯繫我們

    該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

    如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

    A Free Trial That Lets You Build Big!

    Start building with 50+ products and up to 12 months usage for Elastic Compute Service

    • Sales Support

      1 on 1 presale consultation

    • After-Sales Support

      24/7 Technical Support 6 Free Tickets per Quarter Faster Response

    • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.