Générer une bibliothèque cliente

Cette page explique comment générer une bibliothèque cliente à partir de votre API backend. Toute application Java ou Android peut utiliser cette bibliothèque pour appeler l'API.

Pour créer des clients iOS pour votre API, nous vous recommandons d'utiliser la bibliothèque cliente Objective-C des API Google pour les API REST.

Avant de commencer

Générer la bibliothèque cliente

Les instructions suivantes indiquent comment utiliser les plug-ins Apache Maven et Gradle de Cloud Endpoints Frameworks pour générer un groupe de clients Gradle à partir de l'exemple de projet Maven de la page relative aux premiers pas avec Endpoints Frameworks.

Pour générer une bibliothèque cliente :

  1. Créez votre API.

  2. Exécutez l'outil de ligne de commande Endpoints Frameworks comme suit :

    Maven

    mvn endpoints-framework:clientLibs

    Gradle

    gradle endpointsClientLibs

    Patientez le temps que l'outil génère la bibliothèque. Si l'opération aboutit, l'outil affiche un message semblable à celui-ci :

    Maven

    API client library written to target/client-libs/echo-v1-java.zip

    Gradle

    API client library written to build/endpointsClientLibs/echo-v1-java.zip

  3. Décompressez le fichier à l'aide de l'utilitaire unzip ou d'un autre utilitaire de désarchivage compatible ZIP :

    unzip ./echo-v1-java.zip

  4. Changez de répertoire :

    cd echo

  5. Créez la bibliothèque cliente :

    Maven

    mvn clean package

    La sortie se trouve dans le répertoire target/. Le nom exact du fichier dépend de la version du client Java. Il devrait ressembler à echo-v1-1.23.0-SNAPSHOT.jar.

    Gradle

    gradle build

    La sortie se trouve dans le répertoire build/libs. Le nom exact du fichier dépend de la version du client Java. Il devrait ressembler à echo-v1-1.23.0-SNAPSHOT.jar.

  6. Ajoutez le fichier JAR de la bibliothèque cliente à votre application Java ou Android.

  7. Répétez ces étapes chaque fois que vous modifiez le code de l'API.

Étapes suivantes