Cloud Endpoints 门户使用入门

本页面介绍了 Cloud Endpoints 服务门户的创建方法以及门户的界面。 并针对每项任务提供完成该任务至少需要具备的一个或多个 Cloud Identity and Access Management 角色。如需详细了解 Cloud IAM 权限,请参阅以下内容:

前提条件

本页面假定您已经完成以下操作:

创建门户

如需创建门户,请执行以下操作:

  1. 在 Google Cloud Console 中,转到 Endpoints > 开发者门户页面。

    转到 Cloud Endpoints 门户

  2. 选择该 API 所属的 Cloud 项目。
  3. 点击创建门户。生成门户通常需要 5 到 10 分钟。门户创建完毕后,系统会显示指向该门户的网址。

创建门户会产生如下效果:

  • 在门户创建期间,系统会创建名为 service-YOUR_PROJECT_NUMBER@endpoints-portal.iam.gserviceaccount.com 的服务帐号,该帐号具有 Endpoints Portal Service Agent 角色。(YOUR_PROJECT_NUMBER 是您的 Cloud 项目的项目编号。)您可以在 Cloud Console 中 GCP 项目所对应的 IAM 和管理员 > IAM 页面上查看此服务帐号。

  • 创建门户后,该门户将使用域名 endpointsportal.YOUR_PROJECT_ID.cloud.googYOUR_PROJECT_ID 是您的 Cloud 项目 ID。为此,即使您的门户无法公开访问,系统也会创建包含项目 ID 的 SSL/TLS 证书和公共 DNS 记录,并且这些证书和记录能够在公开的证书透明度日志中搜索到。

查看 API 的门户

要查看 API 的门户,请执行以下操作:

  1. Endpoints > 开发者门户页面的门户网址部分中,点击网址。
  2. 按照登录提示继续访问您的门户。如果您有多个帐号,请务必选择 API 所在的 Cloud 项目中的帐号。

    随即将显示您门户的主页。为方便起见,建议您为此网址添加书签。门户主页会显示一个列表,其中包含 Cloud 项目中所有 API 的链接。

  3. 点击要浏览的 API。随即将显示该 API 的主页。

门户界面简介

在 API 主页的底部,您会看到以下图标,这些图标为您的 API 用户提供了有用的链接。

  • API 参考 显示 Endpoints 门户从 OpenAPI 文档中生成的 SmartDocs API 参考文档的第一页。您可以使用左侧的导航栏查看每种方法和资源的 SmartDocs 文档。

  • 入门 在“入门指南”中显示示例内容。在向您的 API 用户发送门户网址之前,请自定义此文档,以向您的 API 用户提供开始在其代码中使用 API 时所需的信息。如需了解如何修改入门指南中的内容,请参阅添加自定义文档

  • 获取密钥 显示 API 和服务 > API 库页面,以便用户可以在自己的 Google Cloud 项目中启用您的 API。

    如果您的 API 需要 API 密钥,那么用户在启用您的 API 后,可以导航到 API 和服务 > 凭据页面,以获取可在其代码中使用的 API 密钥。在将门户网址发送给 API 用户之前,您必须向用户授予 API 使用权限。如需了解详情,请参阅控制哪些人能够启用您的 API

自定义门户的外观

您可能需要更改门户上显示的配色方案和图标等元素,以便与公司网站相协调。通过更改门户的外观并为其设置自定义网域,您可以为用户打造品牌化的体验。

要自定义门户的外观,请执行以下操作:

  1. 点击页面右上角的设置

  2. 点击网站级标签。您可以更改以下元素的外观:

    • 徽标
    • 主要颜色,用作主页和标题栏背景色。
    • 辅助颜色,用作图标和链接的颜色。
    • 主页标题。
    • 主页说明。
  3. 点击保存

删除门户

要删除门户,请执行以下操作:

  1. 在 Cloud Console 中,转到 Endpoints > 开发者门户页面。

    转到 Cloud Endpoints 门户

  2. 选择该 API 所属的 Cloud 项目。
  3. 点击删除
  4. 在确认对话框中点击删除

后续步骤

了解: