JAX-WSを使用してJavadocからWSDLドキュメントを生成する方法はありますか?

Question

これを実現する何らかの拡張機能が利用できることを願っています (ただし、私の希望は愚かにも楽観的だと思います)。

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

Answer 1

見てもいいでしょう 発音する. 。使用可能です Mavenプラグインです Javadoc コメントから静的 HTML ファイルを生成します。これは SOAP で機能します (つまり、JAX-WS) と REST (すなわち、JAX-RS) エンドポイント。

興味深い記事:

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

製作例：

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

Answer 2

WSDL ドキュメントを生成する方法を探しているのはあなただけではありません (「 Javadoc からの WSDL ドキュメントの生成 スレッド）しかし、私の知る限り、それはありません 標準 これを行うための JAX-WS の方法。

ここで、JBoss 独自のアノテーションを見てみましょう。 @Documentation で述べた JBWS-1850 生成する jaxws:binding セクションで説明されているアーティファクト 2.9 Javadocのカスタマイズ Java -> WSDL アプローチを使用する場合も同様です。それはあなたが求めているものとまったく同じではありませんが、いくつかのアイデアが得られるかもしれません。

いずれにせよ、これには独自のものを提供する必要があると思います WSDLGeneratorExtension 拡張します wsgen 必要な WSDL を生成します。

Answer 3

1つのプロジェクトでは、WSDLは、多くのを発表しました。すべてのWebサービスのために我々はWS法「getDocumentationURLを（）」さらされています。この方法では、SEIから生成されたJavadocへのリンクを戻って提供します。 JavaDocのは、アクセス可能なイントラネット・サーバー上の場所だった。