有没有类似 javadoc 的工具从 JAX-RS 注释生成 RESTful Web Service apidoc？[已关闭]

rest java documentation jax-rs

2022-09-02 13:29:31

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

如果能够在我的代码上运行一个javadoc式的工具来生成这个界面的一组简洁的文档，那就太好了，但我似乎找不到任何东西。

javadoc本身生成的文档需要太多的修剪，我真的想要一些能够理解JAX-RS注释的语义并生成一些对想要使用我的服务的开发人员友好的东西。

答案 1

看看Enunciate。有一个Maven插件可以生成包含在网站中的文档。

答案 2

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

最好的部分是你绝对不做任何事情。:)当您更改类中的 URI 或参数注释时，它们将自动反映在本文档中。Resource

哒哒哒！:)