De toute façon de générer des documents WSDL à partir Javadoc avec JAX-WS?

Question

J'espère que l'extension d'un certain type est disponible qui fait cela (même si je suppose que mon espoir est bêtement optimiste).

   /**
     * <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;

Merci, Les2

Answer 1

Vous pouvez regarder Enunciate . Il est possible d'utiliser il est plugin Maven pour générer des fichiers HTML statiques de commentaires Javadoc. Cela fonctionne pour SOAP (à savoir JAX-WS) et de repos (à savoir JAX-RS) points d'extrémité.

Intéressant lit comme suit:

• https://github.com/stoicflame/enunciate/wiki/Documentation-Only
• http://raibledesigns.com/rd/entry/my_experience_with_java_rest

Exemples de production:

• http://www.realtybaron.com/api/
• http://www.agentrank.com/api/
• http://api.setlist.fm/docs/index.html

Answer 2

Vous n'êtes pas le seul à chercher un moyen de générer de la documentation WSDL (consultez la documentation Génération WSDL de Javadoc fil), mais, autant que je sache, il n'y a pas standard JAX-WS pour ce faire.

Maintenant, peut-être avoir un regard sur l'annotation exclusive JBoss @Documentation mentionné dans JBWS-1850 qui génère des artefacts de jaxws:binding décrits dans la section 2,9 Javadoc personnalisation lors de l'utilisation Java-> approche WSDL ainsi. Ce n'est pas exactement ce que vous avez demandé, mais il pourrait vous donner quelques idées.

Dans tous les cas, je suppose que cela nécessiterait de fournir votre propre WSDLGeneratorExtension d'étendre wsgen et générer le WSDL souhaité.

Answer 3

Dans un projet, nous avons publié un grand nombre de fichiers WSDL. Pour chaque service Web, nous avons exposé une méthode de WS « getDocumentationURL () ». Cette méthode restituera un lien vers le JavaDoc généré par le SEI. Le JavaDoc a été place sur un serveur intranet accessible.