Cloud Endpoints for OpenAPI

Cloud Endpoints is an API management system that you use to host, protect, and monitor your 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 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 information on other types of API frameworks supported by Cloud Endpoints, see All Endpoints Docs.

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

  1. To get familiar with the deployment steps and see Cloud Endpoints features in action, do the Quickstart for Cloud Endpoints, which uses scripts to deploy a sample API to a Google App Engine flexible backend.

  2. Now you need to decide which compute platform you want to use for your API. Cloud Endpoints for OpenAPI depends on ESP for API management. 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

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.
  • The Debian 8 package google-cloud-endpoints-jessie.
  • Source code in GitHub. See the ESP README for details on building ESP.

You can run the ESP container on the following:

Notes:

Send feedback about...

Cloud Endpoints with OpenAPI