documentacion - ¿Alguna forma de generar documentación WSDL desde Javadoc con JAX-WS?
javadoc comandos (3)
Espero que esté disponible una extensión de algún tipo que haga esto (aunque supongo que mi esperanza es tontamente 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
En un proyecto publicamos muchos WSDLs. Para cada servicio web, hemos expuesto un método WS "getDocumentationURL ()". Este método devuelve un enlace al JavaDoc generado desde el SEI. El JavaDoc se colocó en un servidor de intranet accesible.
No es el único que está buscando una manera de generar documentación WSDL (consulte la documentación de Generación WSDL desde el hilo de Javadoc ) pero, AFAIK, no hay una manera estándar de JAX-WS para hacer esto.
Ahora, quizás eche un vistazo a la anotación propietaria de JBoss @Documentation mencionada en JBWS-1850 que genera jaxws:binding artefactos de jaxws:binding descritos en la sección 2.9 Personalización de Javadoc cuando se utiliza el enfoque Java -> WSDL también. No es exactamente lo que pediste, pero podría darte algunas ideas.
En cualquier caso, supongo que esto requeriría proporcionar su propia WSDLGeneratorExtension para extender wsgen y generar el WSDL deseado.
Puedes mirar a Enunciate . Es posible usar su complemento de Maven para generar archivos HTML estáticos a partir de los comentarios de Javadoc. Esto funciona para los puntos finales SOAP (es decir, JAX-WS) y REST (es decir, JAX-RS).
Lecturas interesantes:
- https://github.com/stoicflame/enunciate/wiki/Documentation-Only
- http://raibledesigns.com/rd/entry/my_experience_with_java_rest
Ejemplos de producción: