第一次在Java中创建一个API

内容来源于 Stack Overflow,并遵循CC BY-SA 3.0许可协议进行翻译与使用

  • 回答 (2)
  • 关注 (0)
  • 查看 (12)

为了与外部应用程序进行通信,我有权设计一个由我必须开发的GUI使用的API列表。考虑到应用程序刚刚设计好,并且我有它的初始类图,我应该:

1-只需列出GUI应用程序类图中的字段和方法,以便与应用程序进行通信

要么

2-创建GUI所需的全新字段和方法的列表,以便与应用程序开发人员应创建的应用程序进行通信

提问于
用户回答回答于

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

这工作得很好。

做完这些之后,尝试编写文档 - 附有详细的示例。如果您的文档很难编写,混淆或跛脚,那么您需要修复API以添加功能。

然后展示给其他人。

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

在人们实际上感到困惑或实际抱怨之前,不要做任何超过最低限度的事情。

用户回答回答于

我所阅读的API设计的最佳指南之一是“ API小设计手册 ”(PDF),它对于如何为应用程序或服务创建API 有一些很好的平台中立指导。一些最重要的指导是:

  • 在开始编写API本身之前创建用例;
  • 在您编写代码之前获得API设计的同行评审;
  • 编写针对API的示例以测试其稳健性。

第一个提示是最好的,恕我直言; 它会阻止你编写一个API,当你的所有用例需要的只是这个世界的一小部分时,它就提供了这个世界。这也迫使你想出如何使用它,并根据这些用途而不是抽象的方式作出设计决定。

扫码关注云+社区