À propos de Cloud Endpoints Frameworks pour Java

Cette page présente les bibliothèques et les outils, ainsi que d'autres informations pour vous aider à commencer à utiliser Endpoints Frameworks pour Java. Consultez la section À propos de Cloud Endpoints Frameworks pour obtenir une vue d'ensemble de l'architecture de Cloud Endpoints Frameworks.

Bibliothèques et outils

Cloud Endpoints Frameworks pour l'environnement standard App Engine offre les outils et les bibliothèques suivants :

• Endpoints Frameworks est disponible dans le dépôt central Maven dans le groupe com.google.endpoints. Le fichier .jar de base requis se trouve dans l'artefact endpoints-framework. Consultez la section API Javadoc pour plus de détails.
• L'outil de ligne de commande endpoints (pour Linux) ou endpoints.cmd (pour Windows) que vous pouvez utiliser pour générer des groupes de bibliothèques clientes et des documents Discovery, permettant aux applications Android et à d'autres types d'applications clientes d'accéder à votre API.
• Le plug-in Maven Endpoints Framework et le plug-in Gradle de Endpoints Framework que vous utilisez pour générer les éléments suivants :
  • Des groupes de bibliothèques clientes et des documents Discovery
  • Des fichiers de configuration OpenAPI, que vous utilisez si vous souhaitez bénéficier de fonctionnalités de gestion des API telles que la surveillance, la journalisation et la validation de clés API

Remarque : Étant donné que le backend de l'API est une application App Engine, les développeurs peuvent utiliser les services et fonctionnalités disponibles dans l'environnement standard App Engine, tels que Datastore, Cloud Storage, le service Mail, le service URL Fetch ou les files d'attente de tâches. Enfin, en utilisant App Engine pour le backend, les développeurs n'ont plus à se soucier des tâches d'administration système, de l'équilibrage de charge, du scaling et de la maintenance du serveur.

Conditions requises

Pour utiliser Endpoints Frameworks, suivez le processus présenté dans le tutoriel.

Vous devez savoir comment développer le client de votre choix, tel que des clients Web JavaScript ou des clients mobiles (comme Android).

Remarque :Vous ne pouvez pas appeler une API Cloud Endpoints directement à partir d'une file d'attente d'envoi de tâches ou d'une tâche Cron.

Processus de développement

Le workflow général pour développer une application à l'aide de Endpoints Frameworks est le suivant :

1. Créez votre projet d'API, puis écrivez le code de votre API.
2. Annotez votre API pour pouvoir générer des classes et des bibliothèques clientes.
3. Générez le fichier de configuration OpenAPI et déployez-le comme décrit dans le tutoriel.
4. Vous pouvez éventuellement tester votre API localement.
5. Déployez l'API.
6. Générez la bibliothèque cliente.
7. Écrivez votre application cliente à l'aide de la bibliothèque cliente lorsque vous appelez l'API.

Comment en profiter ?

Pour commencer, suivez le tutoriel pour configurer, déployer et envoyer des requêtes à un exemple d'API. Revenez ensuite à cette section pour obtenir les informations dont vous avez besoin pour configurer, déployer et tester votre propre API.

Migrer à partir de Cloud Endpoints version 1.0

Si vous avez déjà développé un backend d'API à l'aide de la version précédente de Endpoints, suivez le Guide de migration pour déplacer votre application vers Endpoints 2.0.