Web services 如何记录web服务API?

Web services 如何记录web服务API?,web-services,wsdl,wsdl2java,java2wsdl,Web Services,Wsdl,Wsdl2java,Java2wsdl,我在记录我的web服务API时遇到问题。它是用Java编写的,然后我使用java2wsdlgo生成wsdl文件,等等 如何为此创建文档?我需要一些文档,我可以给用户。我是否记录了我的初始Java代码 应该如何做?您的WSDL文件包含有关服务的所有详细信息。它清楚地说明了您的服务的输入和输出。除此之外,您还可以以wiki/doc的形式提供服务的详细信息,其中解释了服务、预期输入、响应和错误代码等 如果需要,还可以为项目生成JavaDoc。我对wiki文档非常怀疑。我的意思是,我需要以某种方式跟踪A

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

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


应该如何做?

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


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

我对wiki文档非常怀疑。我的意思是,我需要以某种方式跟踪API的变化,等等。我认为没有任何其他选择……只要服务有任何变化,你就必须不断更新你的文档。