我正在为我正在编写的系统设计一个内部API。 API设计中有哪些最佳实践需要考虑?设计API时的最佳实践
回答
测试驱动开发。
TDD会通知您的设计,因为它会提示您提出问题,例如“我该怎么做这件事”,并且随着您的修订,您可以更轻松地重构信心。它也鼓励让事情尽可能简单,这总是一件好事。
请记住,API 是一个用户界面。我试图把重点放在
- 做的一两件事,
- 保持一个有用的功率重量比,
- 避免含义模糊的名称,并
- 通过测试和有效的文档 明确指定行为
你的意思是开发者界面? *应用程序*编程接口不被最终用户直接使用。 – 2010-10-16 18:21:34
应用程序员也是人:)当他们使用应用程序编程接口时,他们是该编程接口的“用户”。在设计API时,名称,文档和最小化访问都非常重要。 – 2010-10-16 18:24:00
+1给柜台。术语UI可能超载,但意图是明确的。一切都有用户 - 微处理器,编程语言,框架,库;不管我们给这些用户的专业名称如何。 – Anurag 2010-10-16 18:27:28
这些示例是用Java编写的,但提示适用于任何语言。
- 1. 最佳VHDL设计实践
- 2. 针对JSP的最佳设计实践
- 3. GWT中的MVP:最佳设计实践
- 4. 最佳实践数据库设计
- 5. 数据库设计最佳实践
- 6. 星型架构设计/最佳实践
- 7. VB.NET最佳实践和设计类
- 8. 最佳实践,对象设计ASP.NET MVC
- 9. Grails commandObject - 设计最佳实践
- 10. GWT面板设计最佳实践
- 11. 可可回调设计:最佳实践
- 12. modalPanel和设计最佳实践
- 13. API自动化框架的最佳实践设计模式
- 14. 设计API的最佳实践和指导原则
- 15. RESTful API最佳实践
- 16. 什么是REST API和用户角色设计最佳实践?
- 17. API访问与设计认证 - 最佳实践?
- 18. 最佳实践:在设计时或运行时添加控件
- 19. 最佳实践
- 20. 最佳实践
- 21. 最佳实践
- 22. 最佳实践
- 23. 最佳实践
- 24. 最佳实践
- 25. 最佳实践
- 26. 最佳实践
- 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