Cloud Endpoints is an API management system that helps you secure, monitor, analyze, and set quotas on your APIs using the same infrastructure Google uses for its own APIs. Endpoints works with the Extensible Service Proxy (ESP) to provide API management. You can find out more about Endpoints and ESP in About Endpoints.
Endpoints supports version 2 of the OpenAPI Specification (formerly known as the Swagger spec)—the industry standard for defining REST APIs. If you are unfamiliar with the OpenAPI Specification, see OpenAPI Overview.
This documentation set shows you how to use Endpoints with OpenAPI. For documentation on the other Endpoints options, see All Endpoints Docs.
To get started, we recommend the following path through the documentation:
To see Endpoints features in action, do the Quickstart for Cloud Endpoints, which uses scripts to deploy a sample API to the App Engine flexible environment.
After you have decided on the backend for your API, walk through a tutorial for your preferred compute platform.
Supported compute platforms
Endpoints for OpenAPI depends on ESP for API management. ESP is an Open Source project and is available to you in the following ways:
- A container in Google Container Registry. See the ESP release notes for the current Docker image.
- Source code in GitHub. See the ESP README for details on building ESP.
You can run the ESP container yourself on the following:
- Cloud Run
- Compute Engine
- Kubernetes, including Google Kubernetes Engine
- A Linux or macOS computer or another platform
For the App Engine standard generation 1 environment, you must use Endpoints Frameworks. If you instead deploy the container to one of the compute options above, you can proxy to either generation of App Engine standard runtime.