Plug-in Endpoints Framework Maven

Le plug-in Endpoints Framework Maven fournit des tâches et des configurations permettant de créer des projets Endpoints Framework. Il offre une compatibilité côté serveur et côté client. Les objectifs côté serveur génèrent des documents de découverte et des spécifications OpenAPI à partir d'un projet Endpoints Framework Java annoté et de bibliothèques clientes. L'objectif côté client génère des bibliothèques clientes lorsqu'un document de découverte est disponible.

Ajouter le plug-in Endpoints Framework Maven

Pour ajouter la dépendance du plug-in Endpoints Framework Maven, placez l'extrait de code suivant dans votre fichier pom.xml.

<plugin>
      <groupId>com.google.cloud.tools</groupId>
      <artifactId>endpoints-framework-maven-plugin</artifactId>
      <version>1.0.2</version>
      <configuration>
        <!-- plugin configuration -->
        <hostname>${endpoints.project.id}.appspot.com</hostname>
      </configuration>
    </plugin>

Objectifs du plug-in

Une fois que vous avez ajouté le plug-in Endpoints Framework Maven, les objectifs Maven propres à Endpoints Framework suivants sont disponibles :

Côté serveur

Objectif Description
endpoints-framework:clientLibs Génère des bibliothèques clientes
endpoints-framework:discoveryDocs Génère des documents de découverte
endpoints-framework:openApiDocs Génère des documents OpenAPI

Côté client

Objectif Description
endpoints-framework:generateSrc Génère des bibliothèques clientes à partir de documents de découverte

Paramètres des objectifs

Chaque objectif est associé à des paramètres que vous pouvez utiliser. Vous pouvez spécifier ces paramètres dans le fichier pom.xml ou dans la ligne de commande.

Pour configurer ces paramètres dans le fichier pom.xml, ajoutez leur nom à la section <configuration>.

Une autre possibilité pour configurer les paramètres dans la ligne de commande consiste à suivre le format -D[USER_PROPERTY]=[PARAMETER_VALUE].

Pour obtenir la liste des paramètres disponibles pour chaque objectif, consultez les sections suivantes.

endpoints-framework:clientLibs

Cet objectif génère des bibliothèques clientes côté serveur.

Paramètre Description Propriétés utilisateur
clientLibDir Définit l'emplacement des bibliothèques clientes générées. L'emplacement par défaut est défini comme "target/client-libs". endpoints.clientLibDir
serviceClasses Paramètre facultatif permettant de fournir une liste de noms de classes de service (classes de point de terminaison). Ceci peut être obtenu à partir du fichier "web.xml". endpoints.serviceClasses
webappDir Indique l'emplacement du répertoire "webapp". L'emplacement par défaut est défini comme "src/main/webapp". endpoints.webappDir
hostname Permet de définir l'URL racine pour les bibliothèques clientes. Par exemple, "hostname = myapp.appspot.com" renvoie l'URL racine par défaut "https://myapp.appspot.com/_ah/api". endpoints.hostname

endpoints-framework:discoveryDocs

Cet objectif génère des documents de découverte.

Paramètre Description Propriétés utilisateur
discoveryDocDir Définit l'emplacement des documents de découverte générés. L'emplacement par défaut est défini comme "target/discovery-docs". endpoints.discoveryDocDir
serviceClasses Paramètre facultatif permettant de fournir une liste de noms de classes de service (classes de point de terminaison). Ceci peut être obtenu à partir du fichier "web.xml". endpoints.serviceClasses
webappDir Indique l'emplacement du répertoire "webapp". L'emplacement par défaut est défini comme "src/main/webapp". endpoints.webappDir
hostname Permet de définir l'URL racine des documents de découverte. Par exemple, "hostname = myapp.appspot.com" renvoie l'URL racine par défaut "https://myapp.appspot.com/_ah/api". endpoints.hostname

endpoints-framework:openApiDocs

Cet objectif génère des documents OpenAPI.

Paramètre Description Propriétés utilisateur
openApiDocDir Définit l'emplacement des documents OpenAPI générés. L'emplacement par défaut est défini comme "target/openapi-docs". endpoints.openApiDocDir
serviceClasses Paramètre facultatif permettant de fournir une liste de noms de classes de service (classes de point de terminaison). Ceci peut être obtenu à partir du fichier "web.xml". endpoints.serviceClasses
webappDir Indique l'emplacement du répertoire "webapp". L'emplacement par défaut est défini comme "src/main/webapp". endpoints.webappDir
hostname Permet de définir l'URL racine des documents OpenAPI. Par exemple, "hostname = myapp.appspot.com" renvoie l'URL racine par défaut "https://myapp.appspot.com/_ah/api". endpoints.hostname

endpoints-framework:generateSrc

Cet objectif génère des sources clientes à partir de documents de découverte.

Paramètre Description Propriétés utilisateur
discoveryDocs Définit la liste des documents de découverte. endpoints.discoveryDocs
generatedSrcDir Répertoire de sortie des sources de bibliothèque cliente générées. L'emplacement par défaut est "target/generated-sources/". endpoints.generatedSrcDir

Étape suivante

  • Explorez le code du plug-in, et signalez les problèmes sur GitHub.