How-to guides

Creating and Deploying an API

• About the API Gateway development environment

  Describes the API Gateway development environment.

• Configuring the development environment

  Describes how to configure your development environment for API development.

• Creating an API

  Describes how to create an API.

• Creating an API config

  Describes how to create an API config using OpenAPI.

• Configuring a gRPC service

  Describes how to create an API config using a gRPC service definition.

• Deploying an API to a gateway

  Describes how to deploy an API config to a gateway.

• Passing data to and from the backend service

  Describes how to pass data to the backend service and receive data back.

Troubleshooting & Monitoring

• Troubleshooting overview

  Provides general troubleshooting information.

• Monitoring your API

  Describes how to monitor the health of APIs using the logs and metrics Endpoints maintains for you automatically.

• Tracing your API

  Explains the trace sampling rate, how to estimate your cost for Cloud Trace, how to view the traces in the Cloud console, and how to disable trace sampling.

• Accessing audit logs

  Describes the audit logs created by API Gateway as part of Cloud Audit Logs.

Authentication & API Keys

• Choosing an Authentication Method

  Provides an overview and sample use cases for each supported authentication method.

• Using JWT to authenticate users

  Provides an overview of user authentication using JSON Web Token (JWT).

• Using Firebase to authenticate users

  Provides an overview of user authentication using Firebase.

• Using AuthO to authenticate users

  Provides an overview of user authentication using AuthO.

• Using Okta to authenticate users

  Provides an overview of user authentication using Okta.

• Using GoogleID tokens to authenticate users

  Provides an overview of user authentication using GoogleID tokens.

• Authentication between services

  Describes how to use service accounts to authenticate human or machine users.

• Securing backend services

  Describes how to secure your backend services and grant the roles and permissions your gateway needs to access those services.

Managing API Access

• API Gateway API Access overview

  Describes the API access control options available to you in API Gateway.

Limiting API Requests

• About quotas

  Provides an overview of the key functionality provided by quotas.

Additional resources

• Using custom domains

  Using custom domains for API Gateway with HTTP(S) Load Balancing.

• Creating multi-region deployments

  Creating multi-region deployments for API Gateway with HTTP(S) Load Balancing.

• Deploying Cloud Endpoints APIs on API Gateway

  Describes how to try your Cloud Endpoints APIs on API Gateway.