用于spring-mvc rest api文档的类似javadoc的工具？ [关闭]

Question

我一直在寻找一个类似 javadoc 的 REST API 文档工具。我已经在 javadoc 中记录了我的 rest 控制器，我认为为前端开发人员创建一个 api 文档会很好。

我认为还没有工具。那么有人知道如何完成这项任务吗？我考虑过使用 classic javadoc tool 并添加一些 spring/rest 特定逻辑。但我还不确定我是否还需要一些特殊的标记或者可能是什么陷阱。最后，我希望有一些工具可以集成到 maven 站点生命周期中，但这应该不难实现。

处理继承可能很困难：我在 REST 资源中经常使用它，但对于读者来说，继承不是她应该关心的。所以子控制器必须以某种方式集成超级控制器的方法，而且还能够在实际控制器的上下文中创建一些有意义的文档。我不确定 spring 是否允许我覆盖来自超级控制器的方法，但仍会评估它的注释。

如果您能提供任何有关相关项目、已经存在的工具或只是您对 javadoc 工具的经验的提示，我将不胜感激！

Answer 1

您应该查看 RESTdoclet。 http://ig-group.github.com/RESTdoclet/

Answer 2

如果你想自己做，你可以这样处理：

1. 创建一个扫描各种@Path 注释的AnnotationReader 实现
2. 测试它是否能够读取name属性
3. 创建一个包含此扫描功能的 Maven mojo
4. 添加工具以将正则表达式参数（例如{customerId}）映射到对文档目的有意义的内容 - 可能通过阅读相关的 Javadoc。

注解阅读器不必对现有注解进行任何修改，因此构建端点正则表达式列表应该很简单。结合 Javadocs，您应该能够创建一个有用的工具。我当然会觉得它很有用，也许其他人也会。

Answer 3

我知道Enunciate，它适用于 Jersey/CXF - 但我不知道它是否适用于 SpringMVC。