将 API 部署到网关

本页面介绍了如何将 API 部署到 API Gateway。

前提条件

在将 API 部署到 API Gateway 之前，请确保您已完成以下操作：

• 按照配置开发环境中的说明准备开发环境。

• 如果使用 Google Cloud CLI，请创建 API。
  注意：如果使用 Google Cloud 控制台，则此步骤会在部署 API 时完成，如以下部分所述。

• 创建用于定义 API 的 OpenAPI 规范。

• 通过 API 定义创建 API 配置。

网关 ID 要求

本文档中介绍的许多 gcloud CLI 命令都要求您指定网关的 ID，格式为：GATEWAY_ID。 API Gateway 对网关 ID 实施以下要求：

• 长度不得超过 49 个字符。
• 只能包含小写字母、数字或短划线。
• 不能以短划线开头。
• 不得包含下划线。

定义已部署的 API 配置的端点

将 API 配置部署到网关时，API Gateway 会在 gateway.dev 网域中为网关创建唯一的网址。然后，您的 API 客户端会使用以下格式的网址访问已部署的 API 配置：

https://GATEWAY_ID-HASH.REGION_CODE.gateway.dev

其中，GATEWAY_ID 是网关的名称，HASH 是部署 API 时生成的唯一哈希代码， 以及 REGION_CODE 是部署网关的 Cloud 位置 的代码。

例如：

https://my-gateway-a12bcd345e67f89g0h.uc.gateway.dev

将 API 部署到网关

如需将 API 部署到网关，请执行以下操作：