Plug-in Endpoints Framework Gradle

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

Dépendance du plug-in

Pour ajouter la dépendance du plug-in Endpoints Framework Gradle, placez l'extrait de code suivant dans votre fichier build.gradle. L'extrait de code récupère la dépendance depuis Maven Central :

classpath 'com.google.cloud.tools:endpoints-framework-gradle-plugin:1.0.2'

Plug-in côté serveur

Pour ajouter le plug-in Endpoints Framework Gradle côté serveur, placez l'extrait de code suivant dans votre fichier build.gradle :

apply plugin: 'com.google.cloud.tools.endpoints-framework-server'

Définissez la configuration côté serveur dans votre fichier build.gradle avant la fermeture de endpointsServer :

endpointsServer {
  // Endpoints Framework Plugin server-side configuration
  hostname = "${projectId}.appspot.com"
}

Tâches et propriétés côté serveur

Les tâches suivantes ne sont exposées que du côté serveur.

endpointsClientLibs

Cette tâche génère des bibliothèques clientes de points de terminaison basées sur les classes de service.

Vous pouvez utiliser les propriétés ci-après :

Propriété	Description
serviceClasses	Liste des classes de service (classes de points de terminaison), pouvant être obtenue à partir du fichier "web.xml".
clientLibDir	Répertoire de sortie des bibliothèques clientes générées.
hostname	Permet de définir l'URL racine des bibliothèques clientes générées. Par exemple, "hostname = myapp.appspot.com" renvoie l'URL racine par défaut "https://myapp.appspot.com/_ah/api".

endpointsDiscoveryDocs

Cette tâche génère des documents de découverte basés sur les classes de service.

Vous pouvez utiliser les propriétés ci-après :

Propriété	Description
serviceClasses	Liste des classes de service (classes de points de terminaison), pouvant être obtenue à partir du fichier "web.xml".
hostname	Permet de définir l'URL racine du document de découverte généré. Par exemple, "hostname = myapp.appspot.com" renvoie l'URL racine par défaut "https://myapp.appspot.com/_ah/api".

endpointsOpenApiDocs

Cette tâche génère des documents OpenAPI basés sur les classes de service.

Vous pouvez utiliser les propriétés ci-après :

Propriété	Description
serviceClasses	Liste des classes de service (classes de points de terminaison), pouvant être obtenue à partir du fichier "web.xml".
hostname	Permet de définir l'URL racine du document OpenAPI généré. Par exemple, "hostname = myapp.appspot.com" renvoie l'URL "hôte" "https://myapp.appspot.com" et "basePath" en tant que "/_ah/api".

Plug-in côté client

Pour ajouter le plug-in Endpoints Framework Gradle côté client, placez la commande suivante dans votre fichier build.gradle :

apply plugin: 'com.google.cloud.tools.endpoints-framework-client'

Définissez la configuration côté serveur dans votre fichier build.gradle avant la fermeture de endpointsClient :

endpointsClient {
  // client-side properties
}

Propriétés côté client

Le plug-in côté client n'expose pas de tâches, contrairement au plug-in côté serveur. L'application du plug-in côté client génère des sources conformément aux propriétés de configuration ci-dessous.

Propriété	Description
discoveryDocs	Liste de documents de découverte à utiliser lors de la génération de sources.

Étape suivante

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