Cloud Endpoints Frameworks v1 has been deprecated and will be shut down on August 2, 2018. We recommend that you use the latest version of this feature, which is renamed to Cloud Endpoints Frameworks for App Engine. This new version supports App Engine standard environment, provides lower latency, and has better integration with App Engine. For more details, see Migrating to 2.0.
Google Cloud Endpoints Frameworks consist of tools, libraries and capabilities that allow you to generate APIs and client libraries from an App Engine application, referred to as an API backend, to simplify client access to data from other applications. Endpoints Frameworks make it easier to create a web backend on App Engine for web clients and mobile clients such as Android or Apple's iOS.
For mobile developers, Endpoints Frameworks provide a simple way to develop a shared web backend and also provides critical infrastructures, such as OAuth 2.0 authentication, eliminating a great deal of work that would otherwise be needed. Furthermore, because the API backend is an App Engine app, the mobile developer can use all of the services and features available in App Engine, such as Datastore, Google Cloud Storage, Mail, Url Fetch, Task Queues, 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.
It is possible to create mobile clients for App Engine backends without Endpoints Frameworks. However, using Endpoints Frameworks makes this process easier because it frees you from having to write wrappers to handle communication with App Engine. The client libraries generated by Endpoints allow you to simply make direct API calls.
Basic Endpoints Frameworks architecture
Here's what using an Endpoints API allows you to do:
Endpoints libraries, tools, and samples
Google Cloud Endpoints Frameworks provide the following libraries and tools:
- The Endpoints library in the SDK.
- Maven artifacts for creating new backend API projects, generating client libraries and generating discovery docs.
- Alternatively to Maven, the
endpoints.shcommand line tool (for Linux), or
endpoints.cmd(for Windows) that you can use to generate client libraries and discovery documents.
Endpoints Frameworks provide the Tic Tac Toe sample that demonstrates a backend API. Companion client samples for that backend are available:
For more samples, refer to the Getting Started tutorials.
To use Endpoints Frameworks, be sure you're using the latest version of the Google App Engine Java SDK.
The general workflow for developing an app using Endpoints Frameworks is:
- Create your backend API project (using Maven to do this is the easiest method), then write your API backend code.
- Annotate your API backend code, so classes and client libraries can be generated from it.
- Generate the client library using Maven, or alternatively, the
endpoints.shcommand line tool.
- Write your client app, using the client library when making calls to the API backend.
To get started, follow the tutorial for writing a backend API.