WADL Outil de Génération de

J'ai eu le même problème: a l'aide de RESTeasy et voulait trouver un moyen de générer de la WADL automatiquement.

Fait quelques recherches et est venu à la solution ci-dessous.

1. Ajoutez ceci à votre 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>

Prêter attention à la buildUri et packagesResourceConfig éléments. Vous avoir à les changer pour refléter la configuration de votre projet. Vous pouvez également modifier le plugin de la version (j'ai utilisé 1.17).

2. Créer un dossier /répertoire doc et ajouter quelques fichiers.

Créer le src/main/doc/ dossier et de créer les deux fichiers ci-dessous.

Fichier: application-doc.xml

Contenu:

<?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>

Fichier: application-grammars.xml

Contenu:

<?xml version="1.0" encoding="UTF-8" ?>
<grammars xmlns="http://wadl.dev.java.net/2009/02" />

3. Exécutez la commande maven.

Aller dans le dossier du projet et exécutez la commande suivante:

$ mvn compile com.sun.jersey.contribs:maven-wadl-plugin:generate

Les fichiers \target\classes\application.wadl (le WADL lui-même) et \target\classes\xsd0.xsd (le schéma de la ressources - il est utilisé par l'application.wadl) devraient être générés.

Modifier et de les utiliser comme vous le souhaitez.

PS.: Gardez à l'esprit que c'est une utilisation très simple de le maven-wadl-plugin. Il peut faire beaucoup plus. Pour mieux le connaître, veuillez consulter le fichier zip mentionné dans la réponse (par Pavel Bucek).

OriginalL'auteur acdcjunior