Outil de ligne de commande Cloud Endpoints Frameworks pour App Engine

Cette page explique comment générer une bibliothèque cliente à partir de votre serveur backend API à l'aide de l'outil de ligne de commande Endpoints Frameworks. N'importe quelle application Java ou Android peut utiliser cette bibliothèque pour appeler l'API.

Vous pouvez générer des groupes de bibliothèques clientes permettant aux applications d'accéder à votre API à l'aide de l'outil de ligne de commande Endpoints Frameworks. Lorsque vous générez une bibliothèque cliente, l'outil de ligne de commande Endpoints Frameworks génère automatiquement un document de découverte décrivant la surface de votre API.

Pour obtenir l'outil de ligne de commande Endpoints Frameworks, téléchargez endpoints-framework-tools à partir du dépôt central Maven. Une fois que vous aurez extrait le contenu du fichier ZIP, vous trouverez l'outil dans le répertoire endpoints-framework-tools-2.2.1/bin/.

Générer un groupe de bibliothèques clientes à partir d'une API

Vous pouvez utiliser l'outil de ligne de commande Endpoints Frameworks pour générer les types de groupes de clients suivants :

  • Maven : ce groupe comprend un fichier pom.xml avec les dépendances d'Endpoints Frameworks et de la bibliothèque cliente des API Google. Le fichier readme.html fournit des informations détaillées sur ce que vous devez ajouter à votre fichier pom.xml pour différents types d'applications clientes et explique comment créer une bibliothèque cliente pour votre API à l'aide de Maven.

  • Gradle : ce groupe comprend un fichier build.gradle avec les dépendances d'Endpoints Frameworks et de la bibliothèque cliente des API Google. Le fichier readme.html fournit des informations détaillées sur ce que vous devez ajouter à votre fichier build.gradle pour différents types d'applications clientes et explique comment créer une bibliothèque cliente pour votre API à l'aide de Gradle.

  • Groupe de clients par défaut : ce groupe contient toutes les bibliothèques de dépendances. Il comporte également le fichier source.jar généré, qui est la bibliothèque Java que vous utilisez dans votre client pour appeler votre API. Ce groupe fournit à votre client toutes les fonctionnalités de la bibliothèque cliente des API Google, y compris OAuth. Le fichier readme.html répertorie les fichiers .jar requis pour différents types d'applications clientes, ainsi que d'autres informations concernant l'utilisation de la bibliothèque cliente.

Si vous utilisez la bibliothèque cliente avec une application Android, nous vous recommandons d'opter pour un groupe de clients Gradle.

Syntaxe de la ligne de commande

Avant d'utiliser l'outil de ligne de commande Endpoints Frameworks, vous devez créer votre projet backend, car cet outil nécessite des fichiers binaires compilés. Vous pouvez éventuellement fournir l'option --war= pointant vers le répertoire de création cible qui contient le répertoire WEB-INF et les classes Java compilées, si vous ne souhaitez pas utiliser la valeur par défaut (--war="./war").

La syntaxe de base est la suivante :

/path-to/endpoints-framework-tools-2.2.1/bin/endpoints-framework-tools \
    get-client-lib OPTIONS CLASS_NAME

où :

  • Le paramètre OPTIONS, s'il est spécifié, correspond à un ou plusieurs éléments du tableau des options.
  • CLASS_NAME est le nom de classe complet de votre API.

Exemple :

/path-to/endpoints-framework-tools-2.2.1/bin/endpoints-framework-tools \
    get-client-lib --war=target/echo-1.0-SNAPSHOT -bs gradle com.example.echo.Echo

où target/echo-1.0-SNAPSHOT est le chemin relatif ou absolu du répertoire de création cible contenant WEB-INF et les classes backend compilées.

Options

Vous pouvez utiliser les options suivantes :

Nom de l'option Description Exemple
build-system Permet de spécifier le type de groupe de clients à produire. Spécifiez gradle pour un groupe de clients Gradle pour Android, maven pour un groupe de clients Maven, ou default (ou omettez simplement cette option) pour un groupe ne contenant que les bibliothèques de dépendances et le fichier JAR source. --build-system=gradle
-bs gradle
war Définit le chemin d'accès au répertoire de création cible WEB-INF contenant le fichier appengine-web.xml et d'autres métadonnées.
Par défaut : ./war.		 --war=target/echo-1.0-SNAPSHOT
-w target/echo-1.0-SNAPSHOT
output Définit le répertoire dans lequel la sortie est écrite.
Il s'agit par défaut du répertoire depuis lequel l'outil est appelé.		 --output=/mydir
-o /mydir

Plates-formes clientes compatibles

Les plates-formes compatibles avec le groupe de clients produit par l'outil de ligne de commande Endpoints Frameworks sont les suivantes :