Cloud Endpoints for OpenAPI Documentation

Google Cloud Endpoints is an API management system that you use to host, protect, and monitor your APIs. You can find out more about Cloud Endpoints 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 backend you want to use for your API. With Cloud Endpoints for OpenAPI, you can run your API on Kubernetes or on any Google Cloud backend (except App Engine Standard or Cloud Functions). To help you make that decision, see Choosing a Computing Option.

  3. After you have decided on the backend for your API, walk through a tutorial for your preferred backend.

Getting Support

See Google Cloud Endpoints Community for the various ways available to you to ask questions and get support on your Cloud Endpoints project.

Monitor your resources on the go

Get the Google Cloud Console app to help you manage your projects.

Send feedback about...

Cloud Endpoints with OpenAPI