Любой способ создания документации WSDL из Javadoc с JAX-WS? - PullRequest
Новая
       49

Любой способ создания документации WSDL из Javadoc с JAX-WS?

18 голосов
/ 17 ноября 2009

Я надеюсь, что есть какое-то расширение, которое делает это (хотя я полагаю, что моя надежда глупо оптимистична). 

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

Спасибо, LES2

Ответы [ 3 ]

10 голосов
/ 22 февраля 2010

Вы можете посмотреть на Enunciate . Можно использовать это плагин Maven для генерации статических файлов HTML из комментариев Javadoc. Это работает для конечных точек SOAP (то есть JAX-WS) и REST (то есть JAX-RS).

Интересные чтения:

Примеры производства:

7 голосов
/ 20 февраля 2010

Вы не единственный, кто ищет способ создания документации WSDL (см. Создание документации WSDL из потока Javadoc ), но, AFAIK, стандарта JAX- нет WS способ сделать это.

Теперь, возможно, взгляните на собственную аннотацию JBoss @Documentation, упомянутую в JBWS-1850 , которая генерирует jaxws:binding артефактов, описанных в разделе 2.9 Настройка Javadoc при использовании Java-> Подход WSDL также. Это не совсем то, что вы просили, но это может дать вам некоторые идеи.

В любом случае, я полагаю, что для этого потребуется предоставить собственный WSDLGeneratorExtension для расширения wsgen и генерации желаемого WSDL.

0 голосов
/ 20 ноября 2012

В одном проекте мы опубликовали много WSDL. Для каждого веб-сервиса мы выставили WS-метод "getDocumentationURL ()". Этот метод возвращает ссылку на JavaDoc, сгенерированный из SEI. JavaDoc был размещен на доступном сервере интрасети.

...