将 API 部署到网关

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

前提条件

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

网关 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 部署到网关，请执行以下操作：

Google Cloud 控制台

  1. 在 Google Cloud 控制台中，前往 API Gateway 页面。

    前往 API Gateway

  2. 点击 创建网关

    系统会显示创建网关 页面。

  3. 在选择 API 中，选择选择 API 字段中的创建新的 API 。
  4. 在显示名称 字段中，输入 API 的显示名称。
  5. 在 API ID 字段中，输入 API 的 ID。请参阅 API ID 要求，了解 API 命名准则。
  6. （可选）为 API 添加标签。
  7. 在 API 配置 部分中，选择选择配置 字段中的创建新的 API 配置
  8. 在上传 API 规范 字段中，上传 .yaml 或 .json 文件。请参阅 OpenAPI 2.0 和 OpenAPI 3.x 文件格式，了解 API 定义。
  9. 在显示名称 字段中，输入 API 配置的显示名称。
  10. 在选择服务账号 列表中，选择所需的服务帐号。API Gateway 会将此服务帐号用作其身份。
  11. （可选）为 API 配置添加标签。
  12. 在网关详细信息 部分中，输入网关的显示名称。
  13. 在位置 字段中，选择要部署网关的 Google Cloud 区域。
  14. （可选）为 API Gateway 添加标签。
  15. 点击创建网关 。

    16. 新创建的 API 会显示在 API Gateway 首页上。

Google Cloud CLI

  1. 验证下面的命令返回的项目 ID，以确保不会在错误的项目中创建网关。

    gcloud config list project

    如果需要更改默认项目，请运行以下命令 并将 PROJECT_ID 替换为要在其中创建服务的 Google Cloud 项目 ID ：

    gcloud config set project PROJECT_ID

  2. 查看 gateway create 命令的相关帮助：

    gcloud api-gateway gateways create --help

  3. 运行以下命令将 API 配置部署到网关：

    gcloud api-gateway gateways create GATEWAY_ID \
 --api=API_ID --api-config=CONFIG_ID \
 --location=GCP_REGION

    其中：

    • GATEWAY_ID 指定新网关的 ID。如果网关尚不存在，则此命令将创建该网关。
    • API_ID 指定与此网关关联的 API Gateway API 的 ID。
    • CONFIG_ID 指定部署到该网关的 API 配置的 ID。您必须在创建网关时指定 API 配置。
    • GCP_REGION 指定已部署网关的 Cloud 位置。