This page describes the libraries and tools and provides other information to help you get started using Endpoints Frameworks with 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
.jarfile is in the
endpoints-frameworkartifact. See API Javadoc for details.
endpointscommand-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.
- The Endpoints Frameworks Maven plugin and the Endpoints Frameworks Gradle plugin, which you use to generate the following:
To use Endpoints Frameworks, follow the process shown in the Tutorial.
The general workflow for developing an app using Endpoints Frameworks is:
- Create your API project, and then write your API code.
- Annotate your API, so classes and client libraries are generated from it.
- Generate the OpenAPI configuration file and deploy it as described in the Tutorial.
- Optionally, test your API locally.
- Deploy the API.
- Generate the client library.
- Write your client app, by using the client library when making calls to the API.
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.