最新版本:
引用第49章。RESTEasy
WADL支持:
Chapter 49. RESTEasy WADL支持
49.1。RESTEasy
WADL支持Servlet容器
49.2。对Sun JDK HTTP Server
49.3的RESTEasy
WADL支持。RESTEasy
WADL对Netty Container
49.4的支持
。RESTEasy
WADL支持Undertow容器RESTEasy拥有自己的支持来为其资源生成WADL,并且它支持几种不同的容器。以下文本将向您展示如何在不同的容器中使用此功能。
49.1。RESTEasy WADL支持Servlet容器
RESTEasy
WADL用于ResteasyWadlServlet支持servlet容器。可以注册web.xml启用WADL功能。这是显示ResteasyWadlServletin
用法的示例web.xml:
> <servlet>> <servlet-name>RESTEasy WADL</servlet-name>> <servlet-class>org.jboss.resteasy.wadl.ResteasyWadlServlet</servlet-> class>> </servlet>> > <servlet-mapping>> <servlet-name>RESTEasy WADL</servlet-name>> <url-pattern>/application.xml</url-pattern>> </servlet-mapping>
中的先前配置
web.xml显示了如何启用ResteasyWadlServlet它并将其映射到/application.xml。然后可以从配置的URL访问WADL:/application.xml
较旧版本的解决方法
有一种解决方法:
maven-wadl-plugin球衣人调用的maven插件也可以为使用RESTEasy编码的服务生成WADL。
这是使用方法。
1.将此添加到您的pom.xml
:
<build> <plugins> <plugin> <groupId>com.sun.jersey.contribs</groupId> <artifactId>maven-wadl-plugin</artifactId> <version>1.17</version> <executions> <execution> <id>generate</id> <goals> <goal>generate</goal> </goals> <phase>${javadoc-phase}</phase> </execution> </executions> <configuration> <wadlFile>${project.build.outputDirectory}/application.wadl </wadlFile> <formatWadlFile>true</formatWadlFile> <baseUri>http://example.com:8080/rest</baseUri> <packagesResourceConfig> <param>com.example.rs.resource</param> </packagesResourceConfig> <wadlGenerators> <wadlGeneratorDescription> <className>com.sun.jersey.server.wadl.generators.WadlGeneratorApplicationDoc </className> <properties> <property> <name>applicationDocsFile</name> <value>${basedir}/src/main/doc/application-doc.xml</value> </property> </properties> </wadlGeneratorDescription> <wadlGeneratorDescription> <className>com.sun.jersey.server.wadl.generators.WadlGeneratorGrammarsSupport </className> <properties> <property> <name>grammarsFile</name> <value>${basedir}/src/main/doc/application-grammars.xml</value> </property> </properties> </wadlGeneratorDescription> </wadlGenerators> </configuration> </plugin> </plugins> </build>注意
baseUri和
packagesResourceConfig元素。您必须更改它们以反映项目的配置。您可能还想更改插件的版本(我使用的是1.17)。
2.创建一个/ doc文件夹并添加一些文件。
创建
src/main/doc/文件夹并在下面创建两个文件。
文件: application-doc.xml
内容:
<?xml version="1.0" encoding="UTF-8"?> <applicationDocs targetNamespace="http://wadl.dev.java.net/2009/02"> <doc xml:lang="en" title="A message in the WADL">This is added to the start of the generated application.wadl</doc> </applicationDocs>
文件: application-grammars.xml
内容:
<?xml version="1.0" encoding="UTF-8" ?><grammars xmlns="http://wadl.dev.java.net/2009/02" />
3.运行maven命令。
转到项目文件夹并运行以下命令:
$ mvn compile com.sun.jersey.contribs:maven-wadl-plugin:generate
应该生成文件
targetclassesapplication.wadl(WADL本身)和
targetclassesxsd0.xsd(资源的模式-
它由application.wadl使用)。
根据需要编辑和使用它们。
PS .:请记住,这是对maven-wadl-plugin的非常简单的使用。它可以做的更多。要更好地了解它,请参考http://search.maven.org/remotecontent?filepath=com/sun/jersey/samples/generate-
wadl/1.12/generate-
wadl-1.12-project.zip中的zip文件。



