Puis-je obtenir de l'application.wadl fichier à l'aide de RESTeasy?

Dernières versions:

Citant Chapitre 49. RESTEasy WADL Soutien:

Chapitre 49. RESTEasy WADL Soutien

49.1. RESTEasy WADL Soutien pour le Conteneur de Servlet

49.2. RESTEasy WADL soutien pour Sun JDK Serveur HTTP

49.3. RESTEasy WADL soutien pour Netty Conteneur

49.4. RESTEasy WADL de Soutien pour les Baïnes Conteneur

RESTEasy a son propre support pour générer WADL de ses ressources, et il prend en charge plusieurs récipients différents. Le texte qui suit va vous montrer comment utiliser cette fonction dans des récipients différents.

49.1. RESTEasy WADL Soutien pour le Conteneur de Servlet

RESTEasy WADL utilise ResteasyWadlServlet à l'appui de conteneur de servlet. Il peut être enregistré dans web.xml pour permettre WADL fonctionnalité. Voici un exemple pour montrer que les usages de ResteasyWadlServlet dans 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>

La configuration précédente, dans web.xml montre comment activer
ResteasyWadlServlet et associé à /application.xml. Et puis l'
WADL peut être consulté à partir de la configuration de l'URL:

/application.xml

---

Solution de contournement pour les Anciennes versions de

Il y a une solution: un plugin maven appelé maven-wadl-plugin par le maillot des gens qui y travaille aussi pour générer WADL pour les services codés à l'aide de RESTEasy.

Voici comment l'utiliser.

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 baseUri 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 dans http://search.maven.org/remotecontent?filepath=com/sun/jersey/samples/generate-wadl/1.12/generate-wadl-1.12-project.zip

OriginalL'auteur

Voir RESTEasy WADL Soutien (3.1.0). L'aide de l'extrait ci-dessous est copié à partir de là

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

Il utilise le ResteasyWadlServlet et fera l'WADL accessibles à /application.xml.

Note:
Rex et Jaskirat l'avons déjà mentionné précédemment que RESTEASY-166 a été utilisé pour gérer la mise en œuvre de cette fonctionnalité. Il semble que cela a été achevé en 3.0.14.

OriginalL'auteur