Cloud Endpoints 门户概览

您可以使用 Cloud Endpoints 门户来创建开发者门户,Cloud Endpoint API 的用户可以访问该网站来浏览和测试您的 API。在您的门户上,在自己的代码中使用 API 的开发者可以找到 SmartDocs API 参考文档。SmartDocs 使用 Cloud Endpoints Frameworks 创建的 OpenAPI 文档来生成 API 参考文档。 SmartDocs 包含一个试用此 API 面板,因此开发者无需退出该文档便可与您的 API 交互。

门户

您还可以提供自己的自定义文档,以帮助用户开始使用您的 API 并顺利上手。

访问 Endpoints 门户演示,以浏览通过多个不同的 Endpoints 示例创建的门户。

限制

  1. 用户必须通过 GCP 项目进行身份验证才能访问开发者门户。未经身份验证的用户无法查看开发者门户。
  2. 如要使用试用此 API 面板,Endpoints 服务必须可公开访问。如果在 Endpoints 服务上配置了其他身份验证(如 IAP),则请求将失败。
  3. Endpoints 门户不支持在单个 Endpoints 部署的不同命名空间中声明的同名消息或服务。这可能会影响用户尝试遵循使用 Endpoints 对 API 进行版本控制的最佳做法。为避免对消息或服务进行不正确的版本控制,请使用以下方法之一:
    • 为所有 .proto 文件中的所有消息和服务指定唯一名称。例如,在版本 1 中将 data 消息命名为 data1,在版本 2 中命名为 data2,等等。
    • 将 API 版本拆分为不同的 Endpoints 部署。

后续步骤