用于spring-mvc rest api文档的javadoc-like工具？

Question

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

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

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

我很欣赏任何关于相关项目的提示，已经存在的工具或者您对javadoc工具的体验！

Answer 1

你应该看一下RESTdoclet。 http://ig-group.github.com/RESTdoclet/

Answer 2

我知道Enunciate，它与Jersey / CXF的效果非常好 - 但我不知道它是否适用于SpringMVC。

Answer 3

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

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

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