首次在 Java 中创建 API

我读过的最好的API设计指南之一是“API设计小手册”（PDF），它有一些关于如何为应用程序或服务创建API的很好的，与平台无关的指南。它提供的一些最重要的指导是：

• 在开始对 API 本身进行编码之前创建用例;
• 在编写代码之前，请对 API 设计进行同行评审;
• 针对 API 编写示例以测试其健壮性。

第一个提示是最好的，恕我直言;它阻止您编写一个API，当您的所有用例都需要该世界的一小部分时，该API提供了世界。它还迫使您思考如何使用它，并根据这些用途而不是抽象地做出设计决策。

“只需列出此应用程序类图中 GUI 与应用程序通信所需的字段和方法”

这非常有效。

完成此操作后，请尝试编写文档 - 并提供详细的示例。如果您的文档难以编写，令人困惑或蹩脚，那么您需要修复API以添加功能。

然后将其展示给其他人。

如果人们感到困惑或抱怨，那么你可能需要向API添加其他功能。

在人们真正感到困惑或真正抱怨之前，不要做任何超过最低限度的事情。