如何记录Web服务API？

Question

我在记录我的Web服务API时遇到问题。它是用Java编写的，然后我用java2wsdl生成wsdl文件等等。

如何为此创建文档？我需要一些我可以提供给用户的文档。我是否记录了我的初始Java代码？

应该怎么做？

Answer 1

您的 WSDL 文件包含有关该服务的所有详细信息。它清楚地说明了您的服务的输入和输出。除此之外，您还可以通过 wiki / doc 的形式提供服务的详细信息，其中说明了服务，预期输入，响应和错误代码等。

如果需要，还可以为项目生成JavaDoc。