As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Python Client for API Gateway

API Gateway: enables you to provide secure access to your backend services through a well-defined REST API that is consistent across all of your services, regardless of the service implementation. Clients consume your REST APIS to implement standalone apps for a mobile device or tablet, through apps running in a browser, or through any other type of app that can make a request to an HTTP endpoint.

• Client Library Documentation

• Product Documentation

Quick Start

In order to use this library, you first need to go through the following steps:

1. Select or create a Cloud Platform project.

2. Enable billing for your project.

3. Enable the API Gateway.

4. Setup Authentication.

Installation

Install this library in a virtual environment using venv. venv is a tool that creates isolated Python environments. These isolated environments can have separate versions of Python packages, which allows you to isolate one project’s dependencies from the dependencies of other projects.

With venv, it’s possible to install this library without needing system install permissions, and without clashing with the installed system dependencies.

Code samples and snippets

Code samples and snippets live in the samples/ folder.

Supported Python Versions

Our client libraries are compatible with all current active and maintenance versions of Python.

Python >= 3.7

Unsupported Python Versions

Python <= 3.6

If you are using an end-of-life version of Python, we recommend that you update as soon as possible to an actively supported version.

Mac/Linux

python3 -m venv <your-env>
source <your-env>/bin/activate
pip install google-cloud-api-gateway

Windows

py -m venv <your-env>
.\<your-env>\Scripts\activate
pip install google-cloud-api-gateway

Next Steps

• Read the Client Library Documentation for API Gateway to see other available methods on the client.

• Read the API Gateway Product documentation to learn more about the product and see How-to Guides.

• View this README to see the full list of Cloud APIs that we cover.

Note

Because this client uses grpc library, it is safe to share instances across threads. In multiprocessing scenarios, the best practice is to create client instances after the invocation of os.fork() by multiprocessing.pool.Pool or multiprocessing.Process.

API Reference

• Services for Google Cloud Apigateway v1 API
  • ApiGatewayService
• Types for Google Cloud Apigateway v1 API

Changelog

For a list of all google-cloud-api-gateway releases:

• Changelog
  • 1.10.1 (2024-10-31)
  • 1.10.0 (2024-10-24)
  • 1.9.5 (2024-07-30)
  • 1.9.4 (2024-07-08)
  • 1.9.3 (2024-03-05)
  • 1.9.2 (2024-02-22)
  • 1.9.1 (2024-02-06)
  • 1.9.0 (2024-02-01)
  • 1.8.0 (2023-12-07)
  • 1.7.3 (2023-09-30)
  • 1.7.2 (2023-07-05)
  • 1.7.1 (2023-03-23)
  • 1.7.0 (2023-02-27)
  • 1.6.1 (2023-01-20)
  • 1.6.0 (2023-01-10)
  • 1.5.1 (2022-12-08)
  • 1.5.0 (2022-11-16)
  • 1.4.0 (2022-11-07)
  • 1.3.3 (2022-10-07)
  • 1.3.2 (2022-09-29)
  • 1.3.1 (2022-08-11)
  • 1.3.0 (2022-07-16)
  • 1.2.2 (2022-06-03)
  • 1.2.1 (2022-03-05)
  • 1.2.0 (2022-02-11)
  • 1.1.1 (2021-11-01)
  • 1.1.0 (2021-10-11)
  • 1.0.4 (2021-09-24)
  • 1.0.3 (2021-07-27)
  • 1.0.2 (2021-07-21)
  • 1.0.1 (2021-07-12)
  • 1.0.1 (2021-06-30)
  • 1.0.0 (2021-06-24)
  • 0.2.0 (2021-05-28)
  • 0.1.0 (2021-03-23)