Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
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. Pour en savoir plus, consultez la section API Javadoc.
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.
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.
Exigences
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).
Processus de développement
Le workflow général pour développer une application à l'aide de Endpoints Frameworks est le suivant :
Créez votre projet d'API, puis écrivez le code de votre API.
Annotez votre API pour pouvoir générer des classes et des bibliothèques clientes.
Générez le fichier de configuration OpenAPI et déployez-le comme décrit dans le tutoriel.
Écrivez votre application cliente à l'aide de la bibliothèque cliente lorsque vous appelez l'API.
Premiers pas
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.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/09/04 (UTC).
[[["Facile à comprendre","easyToUnderstand","thumb-up"],["J'ai pu résoudre mon problème","solvedMyProblem","thumb-up"],["Autre","otherUp","thumb-up"]],[["Difficile à comprendre","hardToUnderstand","thumb-down"],["Informations ou exemple de code incorrects","incorrectInformationOrSampleCode","thumb-down"],["Il n'y a pas l'information/les exemples dont j'ai besoin","missingTheInformationSamplesINeed","thumb-down"],["Problème de traduction","translationIssue","thumb-down"],["Autre","otherDown","thumb-down"]],["Dernière mise à jour le 2025/09/04 (UTC)."],[[["\u003cp\u003eEndpoints Frameworks for Java provides libraries and tools for developing APIs in the App Engine standard environment, found in the \u003ccode\u003ecom.google.endpoints\u003c/code\u003e group within the Maven Central Repository.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eendpoints\u003c/code\u003e command-line tool, along with Maven and Gradle plugins, helps generate client library bundles, Discovery documents, and OpenAPI configuration files.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can leverage App Engine services like Datastore, Cloud Storage, and Task queues when building APIs with Endpoints Frameworks.\u003c/p\u003e\n"],["\u003cp\u003eThe development process involves creating and annotating API code, generating OpenAPI configuration files, deploying the API, and generating client libraries.\u003c/p\u003e\n"],["\u003cp\u003eThere is a tutorial available to get started and a migration guide for those upgrading from the previous version of Endpoints.\u003c/p\u003e\n"]]],[],null,["# About Cloud Endpoints Frameworks for Java\n\nThis page describes the libraries and tools and provides other information to\nhelp you get started using Endpoints Frameworks for Java. See\n[About Endpoints Frameworks](/endpoints/docs/frameworks/about-cloud-endpoints-frameworks)\nfor an architectural overview of Endpoints Frameworks.\n\nLibraries and tools\n-------------------\n\nCloud Endpoints Frameworks for the App Engine standard environment\nprovides the following libraries and tools:\n\n\n- The Endpoints Frameworks is available in the [Maven Central Repository](http://search.maven.org/) in the group `com.google.endpoints`. The base required `.jar` file is in the `endpoints-framework` artifact. See [API Javadoc](/endpoints/docs/frameworks/java/javadoc) for details.\n- The [`endpoints`](/endpoints/docs/frameworks/java/endpoints_tool) command-line tool (for Linux), or `endpoints.cmd` (for Windows) that you can use to generate client library bundles and [Discovery documents](https://developers.google.com/discovery/v1/reference/apis), which allow Android apps and other types of client applications to access your API.\n- The [Endpoints Frameworks Maven plugin](/endpoints/docs/frameworks/java/maven-endpoints-frameworks-plugin) and the [Endpoints Frameworks Gradle plugin](/endpoints/docs/frameworks/java/gradle-endpoints-frameworks-plugin), which you use to generate the following:\n - Client library bundles and Discovery documents.\n - [OpenAPI configuration files](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md), which you use if you want [API management](/endpoints/docs/frameworks/java/adding-api-management) functionality such as monitoring, logging, and API key validation.\n\n| **Note:** Because the API backend is an App Engine application, developers can use services and features available in the App Engine standard environment, such as [Datastore](/appengine/docs/java/datastore) , [Cloud Storage](https://cloud.google.com/storage/docs/overview) , [Mail](/appengine/docs/java/mail) , [Url fetch](/appengine/docs/java/urlfetch) , [Task queues](/appengine/docs/java/taskqueue) , and so forth. And finally, by using App Engine for the backend, developers are freed from system admin work, load balancing, scaling, and server maintenance.\n\nRequirements\n------------\n\nTo use Endpoints Frameworks, follow the process shown in the\n[Tutorial](/endpoints/docs/frameworks/java/get-started-frameworks-java).\n\nYou need to know how to develop the client of your choice, such as JavaScript\nweb clients, or mobile clients, such as Android.\n| **Note:** You cannot call a Cloud Endpoints API directly from a [push task queue](/appengine/docs/standard/java/taskqueue#push_queues) or a [cron job](/appengine/docs/standard/java/config/cron#Java_calling_google_cloud_endpoints).\n\nDevelopment process\n-------------------\n\nThe general workflow for developing an application using\nEndpoints Frameworks is:\n\n1. Create your API project, and then write your API code.\n2. [Annotate](/endpoints/docs/frameworks/java/annotate-code) your API, so classes and client libraries are generated from it.\n3. Generate the OpenAPI configuration file and deploy it as described in the [Tutorial](/endpoints/docs/frameworks/java/get-started-frameworks-java).\n4. Optionally, [test your API locally](/endpoints/docs/frameworks/java/test-deploy#running_and_testing_api_backends_locally).\n5. [Deploy the API](/endpoints/docs/frameworks/java/test-deploy).\n6. [Generate the client library](/endpoints/docs/frameworks/java/gen_clients).\n7. Write your client application by using the client library when making calls to the API.\n\nGetting started\n---------------\n\nTo get started, follow the\n\n\n[Tutorial](/endpoints/docs/frameworks/java/get-started-frameworks-java)\n\nto configure, deploy, and send requests to a sample API. Then come back to this\nsection for the information you need to configure, deploy, and test your own\nAPI.\n\nMigrating from Endpoints version 1.0\n------------------------------------\n\nIf you've already developed an API backend using the previous version of\nEndpoints, follow the\n\n[Migration guide](/endpoints/docs/frameworks/java/migrating)\n\nto move your app to Endpoints version 2.0."]]