Warning: file_get_contents(/data/phpspider/zhask/data//catemap/6/rest/5.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
Resteasy-从Javadoc和注释生成REST文档_Java_Rest_Jax Ws_Jax Rs_Resteasy - Fatal编程技术网

Resteasy-从Javadoc和注释生成REST文档

Resteasy-从Javadoc和注释生成REST文档,java,rest,jax-ws,jax-rs,resteasy,Java,Rest,Jax Ws,Jax Rs,Resteasy,我想找到一种方法,根据JAXB、JAX-RS注释和java文档注释(请不要使用doclet),从java代码(WADL或HTML)中生成漂亮的RESTAPI文档 这是我的项目环境 Spring,没有仅XML的注释 像Rest提供者一样轻松休息 JAXB和JAX-RS注释 JSON中RESTAPI的Mime类型 Java编译器API允许您编写解析Java源代码并执行自己的处理的代码 下面是一个示例,其中包括有关解析注释的信息 我想您可以使用这些API提取所需的原始信息。然而,这将产生语法事实——

我想找到一种方法,根据JAXB、JAX-RS注释和java文档注释(请不要使用doclet),从java代码(WADL或HTML)中生成漂亮的RESTAPI文档

这是我的项目环境

  • Spring,没有仅XML的注释
  • 像Rest提供者一样轻松休息
  • JAXB和JAX-RS注释
  • JSON中RESTAPI的Mime类型

Java编译器API允许您编写解析Java源代码并执行自己的处理的代码

下面是一个示例,其中包括有关解析注释的信息

我想您可以使用这些API提取所需的原始信息。然而,这将产生语法事实——剩余的URL、动作和参数,用户也将受益于额外的解释,服务作者可以(应该?)在Java文档中提供这些解释

完整的解决方案可能是解析注解和java文档,并将两者结合起来。

试试看

Enounceate是一个显著增强JavaWeb服务API的引擎。 很简单。您可以使用标准Java技术开发Web服务API,并将Enounceate附加到构建过程中。突然,您的Web服务API拥有了一些令人印象深刻的特性:

  • 服务的完整HTML文档,从JavaDocs中提取
  • 客户端库(例如Java、.NET、iPhone、Ruby、Flex、AJAX、GWT等),供希望与您的API接口的开发人员使用
  • 接口定义文档(例如WSDL、WADL、XML模式等)
  • 等等

作为<代码>的说明< /代码>,您也可以考虑。它是从我们公司内部使用的一种工具发展而来的,可以免费用于开源项目。它与您描述的完全一样:它结合了jaxrs注释和现有的javadoc注释来生成RESTAPI。它是一个maven插件,您只需将其添加到项目中即可。Jaxb注释在编写时还不受支持,但该工具正在积极开发中,我们根据建议/请求/反馈选择要实现的功能。

right。。。。但我希望有一个更像maven的插件来为我处理这个问题——只生成文档,没有客户端库或类似的东西。我想我假设插件还不存在,并建议如何编写插件。我的建议是只使用JavaDoc。刚刚试过MireDot,非常好!我将MireDot与RestEasy一起使用,它非常酷,易于配置。MireDot唯一的“问题”是所需的许可证密钥。每个人工制品一个。。。(即使是免费的部分)在网上也找不到。有人吗?可以在