方法指南

配置和部署 API

• 配置 Cloud Endpoints

  介绍如何准备 OpenAPI 文档以部署到 Endpoints。

• 部署 Endpoints 配置

  介绍如何将 OpenAPI 文档部署到 Endpoints。

• 部署 API 后端

  介绍如何部署 API 的后端代码和 Extensible Service Proxy (ESP)。

• 在 Kubernetes 上部署

  演示如何在 Kubernetes 上配置和部署 Endpoints。

• 在本地或其他平台上运行 ESP

  演示如何在本地机器或其他云提供商中配置 ESP 实例。

• 比较配置文件

  介绍 Google Cloud 控制台中 端点 > 服务页面上的部署历史记录标签页，以及如何将已部署的服务配置与先前版本进行比较。

• 获取服务名称和配置 ID

  介绍如何获取代管式服务的名称和配置 ID。

问题排查和监控

• 问题排查概览

  提供常规问题排查信息，并提供指向其他页面的链接，以便您了解更多信息。

• 排查 Endpoints 配置部署问题

  介绍在部署 Endpoints 配置时可能会遇到的一些错误以及如何排查这些错误。

• 排查响应错误

  介绍如何排查 API 在响应请求时发生的错误。

• 排查 App Engine 柔性环境部署问题

  介绍如何排查 App Engine 柔性环境中的 Endpoints 部署问题。

• 排查 Compute Engine 部署问题

  介绍如何排查 Compute Engine 上的 Endpoints 部署问题。

• 排查 GKE 部署问题

  介绍如何排查 GKE 上的 Endpoints 部署问题。

• 排查 JWT 验证问题

  如果 JWT 验证失败并且在对客户端的响应中返回错误，可参考此处的问题排查信息。

• 监控您的 API

  介绍如何使用 Endpoints 自动为您维护的日志和指标来监控 API 的运行状况。

• 跟踪您的 API

  介绍跟踪记录采样率、如何估算 Cloud Trace 的费用、如何在 Google Cloud 控制台中查看跟踪记录以及如何停用跟踪记录采样。

Cloud Endpoints 门户

• Endpoints 门户概览

  提供 Endpoints 门户概览，并提供指向 Endpoints 门户演示网站的链接。

• Endpoints 门户使用入门

  介绍 Endpoints 门户的创建方法以及 Endpoints 门户的界面。

• 更新 SmartDocs

  介绍 SmartDocs API 参考文档、SmartDocs 如何使用 OpenAPI 文档中的字段生成 API 文档以及如何重新生成 SmartDocs。

• 试用 API

  介绍如何配置门户以便用户能够试用您的 API。

• 添加自定义文档

  介绍如何更改示例入门指南，以及如何为 Endpoints 门户创建和显示其他文档页面。

• 通过 API 同步自定义文档

  介绍如何使用 API 将自定义文档同步到您的门户。

• 设置自定义网域

  介绍如何将 Endpoints 门户设置为使用自定义网域。

DNS 和 SSL

• 验证域名

  演示如何验证提供 Endpoints API 的域名的所有权。

• 通过域名提供 API

  演示如何设置您的项目以处理 API 请求。

• 为 cloud.goog 网域配置 DNS

  演示如何为使用 cloud.goog 网域（由 Google 拥有和管理）的 Endpoints 服务配置 DNS。

• 通过一个网域提供多个 API

  演示如何在您自己的网域上运行多个独立的 API。

• 为 ESP 启用 SSL

  展示如何为使用 ESP 的已部署 Endpoints 服务启用 SSL 端口。

• 为 ESPv2 启用 SSL

  介绍如何使用 ESPv2 为已部署的 Endpoints 服务启用 SSL 端口。

身份验证和 API 密钥

• 选择身份验证方法

  简要介绍每种受支持的身份验证方法及其使用场景示例。

• 为何及何时使用 API 密钥

  提供有关 API 密钥以及何时使用它们的背景信息。

• 使用 Firebase 对用户进行身份验证

  演示如何配置 OpenAPI 文档，以便 ESP 使用 Firebase 验证来自客户端的传入请求，以对用户进行身份验证。

• 使用 Auth0 对用户进行身份验证

  演示如何配置 OpenAPI 文档，以便 ESP 使用 Auth0 验证来自客户端的传入请求，以对用户进行身份验证。

• 使用 Google ID 令牌对用户进行身份验证

  演示如何配置 OpenAPI 文档，以便 ESP 使用 Google ID 令牌验证来自客户端的传入请求，以对用户进行身份验证。

• 使用自定义方法对用户进行身份验证

  演示如何配置 OpenAPI 文档，以便 ESP 使用自定义提供程序验证来自客户端的传入请求，以对用户进行身份验证。

• 服务之间的身份验证

  演示如何对服务到服务的调用进行身份验证。

• 使用 API 密钥限制访问权限

  介绍如何防止未经授权的客户端应用和服务访问您的 API。

管理 API 访问权限

• API 访问权限概览

  介绍您可以在 Endpoints 中使用的 API 访问权限控制选项。

• 控制谁能启用您的 API

  演示如何控制哪些人可以在其 Google Cloud 项目中启用您的 API。

• 在 Google Cloud 项目中启用 API

  演示如何在 Google Cloud 项目中启用 API。

• 授予和撤消对 API 的访问权限

  演示如何授予不同级别的访问权限，以便其他团队成员可以帮助管理 API。

API 生命周期管理

• API 生命周期管理概览

  介绍 Endpoints API 版本控制功能，以及 Endpoints API 版本控制和预演的最佳实践。

• 删除 API 和实例

  演示如何删除 API 以及关停运行该 API 的实例，以免产生不必要的费用。

• 恢复托管式服务

  演示如何恢复被意外删除的托管式服务。

限制 API 请求（Beta 版）

• 配额简介

  简要概述配额提供的关键功能。

• 配置配额

  介绍如何为 API 配置配额。

• 替换默认配额限制

  介绍如何为特定使用方项目设置不同的配额限制。

自定义 ESP

• 在 Google Kubernetes Engine 上使用自定义 nginx.conf

  介绍如何创建自定义 nginx.conf 文件以将 ESP 部署到 GKE。

• 创建自定义 nginx.conf 以支持 CORS

  展示一些示例，说明如何将 ESP CORS 选项写入 nginx.conf，并以此为起点，在您需要自定义 ESP 中的 CORS 支持时入手。

其他 Endpoints 方法指南

• 迁移到 ESPv2

• 适用于 App Engine 标准环境的 Cloud Endpoints Frameworks 方法指南

• 适用于 gRPC 的 Cloud Endpoints 方法指南