How to document the Java Web Services API

Question

I have a Java web service and want to document an open API so that the documentation can be viewed on the Internet from the same URL as the web service. How is this usually done?

Answer 1

There is no standard way to do this. WSDL is not human readable, and a list of pages - if any - is automatically created by WSDL.

You will need to study how your chosen level of web service, do it and see if there is a way to "connect" to this mechanism.

Answer 2

There is a wddocumentation tag:

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

Answer 3

, iDocIt! WSDL. Open Source Eclipse API. http://code.google.com/p/idocit