是否有类似 javadoc 的工具可以从 JAX-RS 注释生成 RESTful Web 服务 apidoc？ [关闭]答案

【问题标题】：Are there javadoc-like tools to generate RESTful web service apidoc from JAX-RS annotations? [closed]是否有类似 javadoc 的工具可以从 JAX-RS 注释生成 RESTful Web 服务 apidoc？ [关闭]
【发布时间】：2011-12-25 21:47:37
【问题描述】：

我正在通过对资源使用 JAX-RS 注释来使用 CXF 开发 Web 服务。这些注释指定参数名称、默认值以及有效的输入和输出 mime 类型。

如果能够在我的代码上运行 javadoc-esque 工具以生成该接口的简洁文档集，那就太好了，但我似乎找不到任何东西。

javadoc 本身生成的文档需要太多的精简，我真的想要一些能够理解 JAX-RS 注释语义并生成对想要使用我的服务的开发人员友好的东西。

【问题讨论】：

标签： java rest documentation jax-rs

【解决方案1】：

如果您正在构建 Restful web 服务，文档称为 WADL。 WADL 基本上是 Rest 的 WSDL 版本。我使用Jersey 来构建我的 Restful Web 服务。 Jersey 会根据您在资源包中的注释自动创建 WADL。下面是 Jersey 网站上的示例 WADL： https://java.net/projects/jersey/sources/svn/show/trunk/jersey/samples/generate-wadl

最好的部分是你什么都不做。 :) 当您更改 Resource 类中的 URI 或参数注释时，它们将自动反映在本文档中。

TADAA！ :)

【讨论】：

感谢您的链接。我没有听说过 WADL，所以这很有帮助，但我真的在寻找人类可读的东西。有用于将 WADL 转换为 HTML 的 XSLT 样式表，例如 github.com/mnot/wadl_stylesheets
你如何告诉 Jersey @GET(/foo) 表示“检索业务对象栏”而 @QueryParam(name="bla") 表示“以毫秒为单位提供开始日期”）？

【解决方案2】：

看看Enunciate。有一个 Maven plugin 将生成包含在站点中的文档。

【讨论】：

不错！ Maven 集成 - 我在。
很好，但它不支持多个 @FormDataParam 参数。