Générer une bibliothèque cliente

Cette page explique comment générer une bibliothèque cliente à partir de votre API backend Python (correspondant au code exécuté sur le serveur). 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.

Pour les applications JavaScript, consultez la page Envoyer une requête authentifiée à partir de JavaScript.

Avant de commencer

  • Téléchargez la bibliothèque et les outils Cloud Endpoints Frameworks dans le répertoire de votre application, comme indiqué dans la section Premiers pas avec Endpoints Frameworks.
  • Assurez-vous que le code de votre API est correctement décoré avec le code Frameworks attendu.

Générer la bibliothèque cliente

Les instructions suivantes montrent comment utiliser l'outil de ligne de commande Endpoints Frameworks pour générer un ensemble de clients Gradle à partir de l'exemple de code fourni à la page Premiers pas avec Cloud Endpoints.

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

  1. Remplacez le répertoire par celui qui contient votre fichier app.yaml et les classes de l'API.

  2. Exécutez l'outil de ligne de commande Endpoints semblable à celui-ci :

    python lib/endpoints/endpointscfg.py get_client_lib java -bs gradle main.EchoApi
    

    main est la classe contenant votre API, et EchoApi est le nom de cette API.

    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 :

    API client library written to ./echo-v1.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 :

    gradle build
    

    La sortie se trouve dans le répertoire build/libs. Le nom exact du fichier dépendra de la version du client, Le résultat est semblable à echo-v1-1.23.0-SNAPSHOT.jar.

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

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

Étape suivante

Pour obtenir plus d'informations et découvrir un exemple de code montrant comment accéder à une API backend à partir d'un client Python, consultez la page Accéder aux API backend à partir des clients Python.