java - 有什么方法可以使用 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

你可以看看Enunciate。可以使用它的 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 文档），但是，AFAIK，没有标准的 JAX-WS 方法可以做到这一点。

现在，也许看看JBWS-1850@Documentation中提到的JBoss 专有注释，它在使用 Java->WSDL 方法时也会生成第2.9 节 Javadoc 自定义中描述的工件。这不完全是你要求的，但它可能会给你一些想法。jaxws:binding

无论如何，我想这需要您自己提供WSDLGeneratorExtension来扩展wsgen和生成所需的 WSDL。

Answer 3

在一个项目中，我们发布了很多 WSDL。对于每个 Web 服务，我们都公开了一个 WS 方法“getDocumentationURL()”。此方法返回一个从 SEI 生成的 JavaDoc 的链接。JavaDoc 放置在可访问的 Intranet 服务器上。