Cloud Endpoints for OpenAPI

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) and the Extensible Service Proxy V2 (ESPv2) to provide API management. You can find out more about Endpoints, ESP, and ESPv2 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:

  1. 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.

  2. Now you need to decide which compute platform you want to use for your API. To help you make that decision, see Choosing a Computing Option, and see the Supported compute platforms section below.

  3. 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 either ESP or ESPv2 for API management. Both ESP and ESPv2 are Open Source projects and are available to you in the following ways:

  • A container in Google Container Registry.
  • Source code in GitHub.

You can run the ESP container on the following:

You can run the ESPv2 container on the following:

  • App Engine
  • Cloud Functions
  • Cloud Run
  • Knative serving
  • GKE
  • Compute Engine
  • Kubernetes

See About Cloud Endpoints for more.

On the App Engine flexible environment, ESP is automatically deployed for you when you add a few lines to your app.yaml file. For more information, see Deploying your API and ESP. ESPv2 does not support App Engine flexible environment.

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.