3
我正在爲我正在編寫的系統設計一個內部API。 API設計中有哪些最佳實踐需要考慮？設計API時的最佳實踐
A
回答
2
測試驅動開發。
TDD會通知您的設計，因爲它會提示您提出問題，例如「我該怎麼做這件事」，並且隨着您的修訂，您可以更輕鬆地重構信心。它也鼓勵讓事情儘可能簡單，這總是一件好事。
2
請記住，API 是一個用戶界面。我試圖把重點放在
- 做的一兩件事，
- 保持一個有用的功率重量比，
- 避免含義模糊的名稱，並
- 通過測試和有效的文檔 明確指定行爲
+0
你的意思是開發者界面？ *應用程序*編程接口不被最終用戶直接使用。 – 2010-10-16 18:21:34
+0
應用程序員也是人:)當他們使用應用程序編程接口時，他們是該編程接口的「用戶」。在設計API時，名稱，文檔和最小化訪問都非常重要。 – 2010-10-16 18:24:00
+2
+1給櫃檯。術語UI可能超載，但意圖是明確的。一切都有用戶 - 微處理器，編程語言，框架，庫;不管我們給這些用戶的專業名稱如何。 – Anurag 2010-10-16 18:27:28
3
這些示例是用Java編寫的，但提示適用於任何語言。
相關問題
- 1. 的RESTful API設計的最佳實踐
- 2. API設計變更的最佳實踐
- 3. JSON設計最佳實踐
- 4. 最佳VHDL設計實踐
- 5. Android設計最佳實踐
- 6. GWT中的MVP：最佳設計實踐
- 7. 針對JSP的最佳設計實踐
- 8. 最佳實踐，對象設計ASP.NET MVC
- 9. 最佳實踐數據庫設計
- 10. Hbase Scheme設計 - 最佳實踐
- 11. GWT面板設計最佳實踐
- 12. Grails commandObject - 設計最佳實踐
- 13. modalPanel和設計最佳實踐
- 14. 星型架構設計/最佳實踐
- 15. VB.NET最佳實踐和設計類
- 16. 數據庫設計最佳實踐
- 17. 可可回調設計：最佳實踐
- 18. 寧靜api的設計理念和最佳實踐
- 19. API自動化框架的最佳實踐設計模式
- 20. 設計API的最佳實踐和指導原則
- 21. RESTful API最佳實踐
- 22. REST API最佳實踐
- 23. API節流最佳實踐
- 24. API訪問與設計認證 - 最佳實踐？
- 25. 什麼是REST API和用戶角色設計最佳實踐？
- 26. REST API設計 - 最佳實踐：鏈接現有子資源
- 27. 最佳實踐：在設計時或運行時添加控件
- 28. 最佳實踐
- 29. 最佳實踐
- 30. 最佳實踐
不合時代？如從未來？ :)雖然我認爲TDD本身並不意味着成功的祕訣，但是我贊成他。經驗是必要的，但TDD可以幫助您設計API，因爲您不得不使用該API。我要做的另一件事是TDD使用該API的應用程序。 – 2010-10-16 18:14:39
@mike，那個字，我不認爲這意味着你的意思;） – hvgotcodes 2010-10-16 18:17:11
@Ionut，沒有確定的成功方式。但TDD只能以許多不同的方式提供幫助。 – hvgotcodes 2010-10-16 18:18:04