3

我正在为我正在编写的系统设计一个内部 API。API 设计中有哪些最佳实践需要考虑？

4

3 回答 3

3

这些示例使用 Java，但提示适用于任何语言。

如何设计一个好的 API 以及为什么它很重要

于 2010-10-16T18:17:01.443 回答
2

测试驱动开发。

TDD 将通知您的设计，因为它会提示您提出诸如“我需要这样做做什么”之类的问题，并且它使您在进行修订时更容易自信地重构。它还鼓励让事情尽可能简单，这总是一件好事。

于 2010-10-16T18:11:41.773 回答
2

请记住，API是一个用户界面。我试着专注于

  • 做好一件事，
  • 保持有用的功率重量比，
  • 避免神秘的名字，和
  • 通过测试和有效的文档明确指定行为
于 2010-10-16T18:14:53.297 回答