Cualquier forma de generar la documentación Javadoc de WSDL con JAX-WS?
-
20-09-2019 - |
Pregunta
Estoy esperando que una extensión de algún tipo está disponible que hace esto (aunque supongo que mi esperanza es estúpidamente optimista).
/**
* <p>
* Gets the {@link ResultObject} given the identifier. The following
* fields are not available for some users and will contain a null value:
* </p>
*
* <ul>
* <li>{@code resultObject.comment}</li>
* <li>{@code resultObject.anotherObject.actionById}</li>
* <li>{@code resultObject.anotherObject.actionByName}</li>
* </ul>
*
* <p>
* The {@code daysInPurgatory} value will be {@code -1} when not
* applicable
* </p>
*
* @param requestUser
* the user initiating the request
* @param identifier
* the id of the ResultObject
* @return the {@link ResultObject} or {@code null} if none exists
* @throws SomeException
* if the {@code identifier} is {@code null}
*/
@WebMethod
@WebResult(name = "resultObject")
public ResultObject getResultObjectById(
@WebParam(name = "RequestUser", header = true, partName = "RequestUser") final String requestUser,
@WebParam(name = "identifier") final Long identifier)
throws SomeException;
Gracias, Les2
Solución
Usted puede mirar en enunciar . Es posible usar es Maven plugin de para generar archivos HTML estáticas de los comentarios Javadoc. Esto funciona para SOAP (es decir JAX-WS) y REST (es decir, JAX-RS) puntos finales.
Interesante lee:
- https://github.com/stoicflame/enunciate/wiki/Documentation-Only
- http://raibledesigns.com/rd/entry/my_experience_with_java_rest
Ejemplos de Producción:
Otros consejos
Usted no es el único que busca una manera de generar la documentación WSDL (consulte la documentación de Javadoc < Generación de WSDL / a> hilo), pero, que yo sepa, no hay ninguna estándar forma / JAX-WS para hacer esto.
Ahora, tal vez echar un vistazo a JBoss @Documentation
anotación especializados para este JBWS-1850 que genera artefactos jaxws:binding
descritos en la sección 2,9 Javadoc personalización cuando se utiliza Java> enfoque WSDL también. No es exactamente lo que usted pidió pero podría darle algunas ideas.
En cualquier caso, supongo que esto requeriría proporcionar su propia WSDLGeneratorExtension
extender wsgen
y generar el WSDL deseada.
En un proyecto que publicó una gran cantidad de WSDL. Por cada servicio web que hemos expuesto un método WS "getDocumentationURL ()". Este método de entregar un enlace de vuelta a la JavaDoc generado a partir de la SEI. El JavaDoc era el lugar en el servidor de intranet accesible.