如何记录Java Web服务API

Question

我有一个Java Web服务，想要记录公共API，因此可以从Web服务的相同URL浏览文档。这通常是怎么做的？

Answer 1

有wsdldocumentation标记：

<wsdl:documentation xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">Your Documentation</wsdl:documentation>

Answer 2

没有标准的方法。 WSDL不是人类可读的，并且页面列表 - 如果有的话 - 可以自动生成可能的WSDL。

您需要调查您选择的Web服务层的方式，执行此操作，并查看是否有任何方法可以“挂钩”该机制。

Answer 3

您也可以使用像iDocIt这样的文档工具！向WSDL添加文档。它是一个用于记录API的开源Eclipse插件。 http://code.google.com/p/idocit