我正在通过在资源上使用JAX-RS注释来使用CXF开发Web服务。这些注释指定参数名称,默认值以及有效的输入和输出mime类型。
能够在我的代码上运行一个javadoc-esque工具来生成该接口的简洁文档集将是很好的,但是我似乎找不到任何东西。
由javadoc本身生成的文档将需要进行大量精简,我确实想要一些能够理解JAX-RS注释的语义并为想要使用我的服务的开发人员提供友好信息的工具。
如果要构建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或参数注释时,它们将自动反映在本文档中。
Resource
TADAA!:)