当前位置: 首页 > 面试题库 >

是否有类似Javadoc的工具可从JAX-RS批注生成RESTful Web服务apidoc?[关闭]

欧阳晗日
2023-03-14
问题内容

我正在通过在资源上使用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或参数注释时,它们将自动反映在本文档中。

TADAA!:)



 类似资料:
  • 问题内容: 我已经使用JAXB编写了许多类进行序列化,并且我想知道是否存在一种基于注释为每个对象生成XSD文件的方法。有这个工具吗? 喜欢的东西是 真棒 。有什么可以做的吗? 问题答案: 是的,您可以在JAXBContext上使用该方法: 您可以利用实现控制输出的位置:

  • 我知道Netbeans可以从。wsdl文件生成Java方法。 Netbeans可以基于Java类及其所有方法创建。wsdl文件吗? https://netbeans.org/kb/docs/websvc/jax-ws.html 我知道怎么做那部分。我想知道是否有更好、更快的方法从我已经拥有的Java方法中开发出web服务。 假设我有一个Java接口类,它要求2个字符串输入并返回一个字符串: 那个包

  • 问题内容: 我试图通过注释将无状态EJB注入到JAX-RS Web服务中。不幸的是,EJB是正义的,当我尝试使用它时我得到了。 我究竟做错了什么? 以下是有关我的机器的一些信息: Glassfish 3.1 Netbeans 6.9 RC 2 Java EE 6 你们能举个可行的例子吗? 问题答案: 我不确定这是否行得通。所以: 选项1:使用注入提供程序SPI 实现一个提供程序,它将执行查找并注入

  • 我们不允许对书籍、工具、软件库等寻求建议的问题。您可以编辑问题,以便用事实和引文来回答。 我在一个项目中使用了Netbean工具来自动生成包含每个表的数据库信息的类。是否有替代工具来执行此操作?

  • 我使用Swagger生成了JAX-RS服务器代码,该代码使用以下命令运行: 现在,服务器的目的之一是在ElasticSearch中索引POST请求。但是,在pom中添加弹性搜索高级rest客户端会使服务器在启动时中断。请参阅底部的错误消息。 我还会在底部附上POM文件的内容。 底部附加的Maven依赖项树。 根据Joakim Erdfelt的建议,我尝试将javax-servlet更改为3.1版和

  • apidoc-javadoc-generator 一、项目介绍 apidoc是用node.js开发的可以根据api的注释文档生成相应的RESTful风格的api文档的工具,而且支持多种开发api的语言。 使用apidoc时生成文档时需要 3 步(默认使用者已经安装了node.js、apidoc,如果没有可以根据这个来完成:node.js,v6版本的node.js安装后会把npm也装好, apido