【发布时间】：2013-01-30 12:49:12
【问题描述】：
我在记录我的 Web 服务 API 时遇到问题。用Java写的，然后我用java2wsdl去生成wsdl文件等
如何为此创建文档？我需要一些可以提供给用户的文档。我是否记录了我的初始 Java 代码？
应该怎么做？
【问题讨论】：
标签： web-services wsdl wsdl2java java2wsdl
【发布时间】：2013-01-30 12:49:12
【问题描述】：
您的 WSDL 文件包含有关服务的所有详细信息。它清楚地说明了您的服务的输入、输出。除此之外，您还可以以 wiki/doc 的形式提供服务的详细信息，其中解释了服务、预期输入、响应和错误代码等。
如果您需要，您还可以为您的项目生成 JavaDoc。
【讨论】：
-
我对 wiki 文档非常怀疑。我的意思是，我需要以某种方式跟踪 API 更改等。
-
我认为没有其他选择...只要服务有任何变化，您就必须不断更新您的文档。