方法指南

Cloud Endpoints 门户

• Endpoints 门户概览

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

• Endpoints 门户使用入门

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

• 更新 SmartDocs

  介绍 SmartDocs API 参考文档、SmartDocs 如何使用 Cloud Endpoints Frameworks 所创建 openapi.json 文件中的字段生成 API 文档，以及如何重新生成 SmartDocs。

• 试用 API

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

• 添加自定义文档

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

• 通过 API 同步自定义文档

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

• 设置自定义网域

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

管理 API 访问权限

• API 访问权限概览

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

• 控制谁能启用您的 API

  介绍如何向用户授予在其自己的 Google Cloud 项目中启用您的 API 的权限。

• 在 Google Cloud 项目中启用 API

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

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

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

限制 API 请求

• 配额简介

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

• 配置配额

  介绍如何为 API 配置配额。

• 替换默认配额限制

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

问题排查和监控

• 排查响应错误

  演示如何查看 Cloud Logging 日志以排查响应错误。

• 监控您的 API

  演示如何在控制台中查看 API 指标和 API 日志。

代管式服务

• 比较配置文件

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

• 获取服务名称和配置 ID

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

框架指南 - Java

• 迁移到 Endpoints Frameworks 2.0 版

  介绍如何将现有 Endpoints 1.0 版应用迁移到 Endpoints Frameworks 2.0 版。

• 将 Android 项目迁移至 Endpoints Frameworks 2.0 版

  介绍如何将现有 Android Endpoints 1.0 版应用迁移到 Endpoints Frameworks 2.0 版。

• Java 版 Endpoints Frameworks 简介

  介绍库和工具，并提供其他信息以帮助您开始使用 Java 版 Endpoints Frameworks。

• 设置开发环境

  介绍如何设置开发环境，以便使用 Java 版 Endpoints Frameworks 构建和部署后端 API。

• 将 Guice 与 Endpoints Frameworks 搭配使用

  介绍如何将 Google Guice 与 Java 版 Endpoints Frameworks 项目搭配使用。

• 编写代码并为其添加注释

  介绍如何设计 Endpoints Frameworks 代码的结构并为其添加注释。

• 部署和测试 API

  介绍如何在 Endpoints Frameworks 中部署您的 API。

• 处理 API 版本控制

  演示如何为您的 API 创建和部署多个版本。

• 使用 Apache Maven 和 App Engine 插件

  介绍如何使用 Apache Maven 管理用于 Endpoints Frameworks API 的 App Engine 项目。

• 多类 API

  介绍如何为 Java 版 Endpoints Frameworks 创建使用多个类实现的 API。

• 添加 API 管理

  介绍如何向 API 添加 API 管理功能。

• 移除 API 管理

  介绍如何移除 API 管理功能并删除 API 的代管式服务。

• 恢复托管式服务

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

• 对用户进行身份验证

  介绍如何使用 Java 版 Endpoints Frameworks 在您的 API 中支持通过客户端应用进行用户身份验证。

• 创建客户端 ID

  介绍如何授权对您的 API 后端的访问。

• 排查 JWT 验证问题

  如果 JSON Web 令牌 (JWT) 验证失败，可参考此处的问题排查信息。

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

  介绍如何创建 API 密钥以及如何使用这些密钥来限制 API 访问权限。

• 生成客户端库

  介绍如何通过后端 API 生成客户端库。

• 从 Android 应用调用后端 API

  介绍 Android 客户端如何调用使用 Endpoints Frameworks 构建的后端 API。

框架指南 - Python

• 迁移到 Endpoints Frameworks 2.0 版

  介绍如何将现有 Endpoints 1.0 版应用迁移到 Endpoints Frameworks 2.0 版。

• Python 版 Endpoints Frameworks 简介

  介绍库和工具，并提供了其他信息，以帮助您开始使用 Python 版 Endpoints Frameworks。

• 创建 API

  介绍如何创建适用于 Endpoints Frameworks 的 API。

• 创建使用多个类实现的 API

  介绍如何为 Endpoints Frameworks 创建使用多个类实现的 API。

• 创建网络服务器

  演示如何为使用 Endpoints Frameworks 创建的 API 定义 Web 服务器。

• 部署和测试 API

  介绍如何部署和测试您的 API。

• 处理 API 版本控制

  介绍如何对您的 API 进行版本控制以及如何部署多个版本。

• 添加 API 管理

  介绍如何添加 API 管理支持，以便 Endpoints 完全支持您的 API。

• 移除 API 管理

  介绍如何移除 API 管理功能并删除 API 的代管式服务。

• 恢复托管式服务

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

• 对用户进行身份验证

  介绍如何使用 Endpoints Frameworks 在您的 API 中支持通过客户端应用进行用户身份验证。

• 创建客户端 ID

  介绍如何使获取所需的客户端 ID，并使用正确的 API 修饰器参数将其提供给后端。

• 排查 JWT 验证问题

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

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

  演示如何创建 API 密钥以限制 API 访问权限。

• 生成客户端库

  介绍如何通过后端 API 生成客户端库。

• 从 Android 应用调用后端 API

  介绍如何从 Android 应用调用后端 API。

• 从 Python 客户端访问后端 API

  演示如何从 Python 客户端访问 Endpoints API。

其他 Endpoints 方法指南

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

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