Stay organized with collections
Save and categorize content based on your preferences.
This page describes the libraries and tools and provides other information to
help you get started using Endpoints Frameworks for Java. See
About Endpoints Frameworks
for an architectural overview of Endpoints Frameworks.
Libraries and tools
Cloud Endpoints Frameworks for the App Engine standard environment
provides the following libraries and tools:
The Endpoints Frameworks is available in the
Maven Central Repository
in the group com.google.endpoints. The base required .jar file is in the
endpoints-framework artifact. See
API Javadoc
for details.
The endpoints
command-line tool (for Linux), or endpoints.cmd (for Windows) that you can
use to generate client library bundles and
Discovery documents,
which allow Android apps and other types of client applications to access
your API.
Write your client application by using the client library when making calls
to the API.
Getting started
To get started, follow the
Tutorial
to configure, deploy, and send requests to a sample API. Then come back to this
section for the information you need to configure, deploy, and test your own
API.
Migrating from Endpoints version 1.0
If you've already developed an API backend using the previous version of
Endpoints, follow the
Migration guide
to move your app to Endpoints version 2.0.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-03 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."]]
