java - WADL 生成工具

Question

是否有一种工具可以将描述 REST 服务的 Java 文件作为参数并从中生成 wadl 文件。

Answer 1

我遇到了同样的问题:正在使用 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>

注意 buildUri 和 packagesResourceConfig 元素。您必须更改它们以反射(reflect)项目的配置。您可能还想更改插件的版本(我使用的是 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

文件 \target\classes\application.wadl(WADL 本身)和 \target\classes\xsd0.xsd(资源的模式 - 它用于由 application.wadl) 生成。

根据需要编辑和使用它们。

PS.:请记住，这是对 maven-wadl-plugin 的非常简单的使用。它可以做更多的事情。为了更好地了解它，请参阅其他答案中提到的 zip 文件(Pavel Bucek)。