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. Cloud Endpoints works with the Extensible Service Proxy (ESP) to provide API management. You can find out more about Cloud Endpoints and ESP in About Cloud Endpoints.

Cloud 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 Cloud Endpoints with OpenAPI. For documentation on the other Cloud Endpoints options, see All Endpoints Docs.

To get started, we recommend the following path through the documentation:

  1. To see Cloud 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

Cloud 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:

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.

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Endpoints with OpenAPI
Need help? Visit our support page.