设计API时的最佳实践

时间:2010-10-16 18:10:10

标签: api api-design

我正在为我正在编写的系统设计内部API。 API Design中有哪些最佳实践可供考虑?

3 个答案:

答案 0 :(得分:3)

示例使用Java,但提示适用于任何语言。

How To Design A Good API And Why It Matters

答案 1 :(得分:2)

测试驱动开发。

TDD会告知您的设计,因为它会提示您提出“我需要做什么”之类的问题,这样您就可以更自如地轻松地重构,就像您通过修订一样。它还鼓励尽可能简单,这总是一件好事。

答案 2 :(得分:2)

请记住API 是用户界面。我试着关注

  • 做好一件事,
  • 保持有用的功率重量比,
  • 避免含糊不清的名字,
  • 通过测试和有效文档明确指定行为