是否有类似javadoc的工具从JAX-RS注释生成RESTful Web服务apidoc?

时间:2011-02-12 00:48:48

标签: java rest documentation jax-rs

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

能够在我的代码上运行一个javadoc-esque工具来生成一个简洁的这个接口文档,但我似乎无法找到任何东西。

javadoc本身生成的文档需要进行过多的修改,我真的想要了解JAX-RS注释的语义,并为想要使用我的服务的开发人员生成一些友好的东西。

2 个答案:

答案 0 :(得分:14)

看看Enunciate。有一个Maven plugin会生成网站中包含的文档。

答案 1 :(得分:6)

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

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

TADAA! :)