适用于 OpenAPI 的 Cloud Endpoints

Cloud Endpoints 是一个 API 管理系统，可帮助您使用 Google 用于其自身 API 的同一基础架构来保护，监控、分析和设置 API 配额。Endpoints 可与 Extensible Service Proxy (ESP) 和 Extensible Service Proxy V2 (ESPv2) 配合使用来提供 API 管理功能。如需详细了解 Endpoints、ESP 和 ESPv2，请参阅 Endpoints 简介。

Endpoints 支持 OpenAPI 规范（定义 REST API 的行业标准，以前称为 Swagger 规范）的第 2 版。如果您不熟悉 OpenAPI 规范，请参阅 OpenAPI 概览。

此文档集向您介绍如何将 Endpoint 与 OpenAPI 配合使用。要查看其他 Endpoints 选项的相关文档，请参阅所有 Endpoints 文档。

首先，建议您浏览文档：

  1. 要了解 Endpoints 功能的实际效果，请按照 Cloud Endpoints 快速入门操作。该快速入门介绍了如何使用脚本将示例 API 部署到 App Engine 柔性环境。

  2. 现在，您需要确定要将 API 用于何种计算平台。为帮助您做出决定，请参阅选择计算选项，并参阅下面的支持的计算平台部分。

  3. 确定用于 API 的后端之后，请完成针对您的首选计算平台的教程。

支持的计算平台

适用于 OpenAPI 的 Endpoints 依靠 ESP 或 ESPv2 进行 API 管理。ESP 和 ESPv2 均为开源项目，您可以通过以下方式获得：

  • Artifact Registry 中的容器。
  • GitHub 中的源代码。

您可以在以下环境中运行 ESP 容器：

您可以在以下环境中运行 ESPv2 容器：

  • App Engine
  • Cloud Run functions
  • Cloud Run
  • Knative serving
  • GKE
  • Compute Engine
  • Kubernetes

如需了解详情，请参阅 Cloud Endpoints 简介。

在 App Engine 柔性环境中，向 app.yaml 文件添加几行代码后，系统会自动为您部署 ESP。如需了解详情，请参阅部署 API 和 ESP。ESPv2 不支持 App Engine 柔性环境。

对于 App Engine 第 1 代标准环境，您必须使用 Endpoints Frameworks。如果您将容器部署到上面的某个计算选项，则可以使用代理连接到任一代的 App Engine 标准运行时环境。