Resteasy - 从 Javadoc 和 Annotations 生成 REST 文档 [关闭]答案

【问题标题】：Resteasy - generate REST documentation from Javadoc and Annotations [closed]Resteasy - 从 Javadoc 和 Annotations 生成 REST 文档 [关闭]
【发布时间】：2012-02-01 08:04:40
【问题描述】：

我想找到一种方法从 java 代码（WADL 或 HTML）中生成漂亮的 REST API 文档 - 基于 JAXB、JAX-RS 注释和 java doc cmets（请不要使用 doclet）。

这是我的项目环境

Spring，没有仅 XML 注释
轻松作为 REST 提供者
JAXB 和 JAX-RS 注释
JSON 中 rest API 的 Mime 类型

【问题讨论】：

标签： java rest jax-ws jax-rs resteasy

【解决方案1】：

试试Enunciate。

Enunciate 是一个显着增强 Java Web 服务 API 的引擎。这很简单。您使用标准 Java 技术开发您的 Web 服务 API，并将 Enunciate 附加到您的构建过程中。突然间，您的 Web 服务 API 拥有了一些令人印象深刻的特性：

服务的完整 HTML 文档，从您的 JavaDocs 中抓取。

面向希望与您的 API 交互的开发人员的客户端库（例如 Java、.NET、iPhone、Ruby、Flex、AJAX、GWT 等）。

接口定义文档（例如 WSDL、WADL、XML-Schema 等）

等

【讨论】：

在网上找不到。有人吗？
可以在github.com/stoicflame/enunciate找到

【解决方案2】：

作为Enunciate 的替代品，您还可以考虑MireDot。它是从我们在自己公司内使用的工具发展而来的，它可以免费用于开源项目。它完全符合您的描述：它结合了 jaxrs 注释和现有的 javadoc cmets 来生成一个 rest api。它作为一个 Maven 插件工作，您只需将其添加到您的项目中。在撰写本文时，尚不支持 Jaxb 注释，但该工具正在积极开发中，我们会根据建议/请求/反馈选择要实现的功能。

【讨论】：

刚刚试用了 MireDot，真的很好！
我已经使用 MireDot 和 RestEasy，非常酷且易于配置
MireDot 的唯一“问题”是所需的许可证密钥。每个 artifactId 一个...（即使是免费部分）

【解决方案3】：

Java 编译器 API 允许您编写解析 Java 源代码并执行您自己的处理的代码。

这是一个instructional article，其中包含有关解析注释的信息。

我想您可以使用这些 API 提取所需的原始信息。然而，这将产生语法事实 - REST URL 和操作和参数，用户还将受益于额外的解释，服务作者可以（应该？）在 Java Doc 中提供。

完整的解决方案可能是同时解析注解和 java doc 并将两者结合起来。

【讨论】：

对....但我希望有更多像 maven 插件来为我处理这个问题 - 并且只有文档生成，没有客户端库或类似的东西。
我想我假设一个插件还不存在，并建议如何编写一个插件。我的建议是使用 JavaDoc。