规划您的 Cloud 项目

除用于生产后端的 Cloud 项目外,您可能还需要创建其他 Cloud 项目,本页面针对这些项目的命名约定提供了一些建议。

根据环境的用途或者所处的 API 生命周期阶段,您可能需要执行以下操作:

  • 更改 API 名称或 Cloud Endpoints 服务名称。如需了解详情,请参阅配置 Endpoints
  • 创建其他项目。
  • 更改 API 的路径。

以下是您可能需要使用的一些常见模式:

  • 对 API 进行版本控制:如果您认为将来可能需要做出一些无法向后兼容的更改,请提前规划并在提供 API 的路径中添加版本号。例如:

    • my-api.endpoints.my‐project.cloud.goog/v1/echo
  • 开发/测试实例:每位开发者均应在各自的项目中,使用自己的名字来表示自己的服务版本。例如,开发者 Dan 按如下方式指定自己的服务版本:

    • my-api.endpoints.dan-dev-project.cloud.goog/v1/echo
  • 暂存:在部署到生产环境之前,您需要在位于各自项目中的暂存后端测试您的 API。例如:

    • my-api.endpoints.my‐project-staging.cloud.goog/v1/echo
  • 运行不公开的 Alpha 版本:如果您需要针对某些客户(而不是所有客户)测试服务的新版本,最简单的方法是将 Alpha 版本置于其自己的项目中,这有助于最大限度地与生产环境进行隔离。例如:

    • my-api.endpoints.my‐project-alpha.cloud.goog/v2alpha/echo

    或者,您可以将 Alpha 版本置于同一项目中,不过需要将其配置为单独的服务。由于这是一项单独的服务,因此您可以限制访问权限,以便仅允许 Alpha 版客户访问该服务。例如:

    • my-api-alpha.endpoints.my-project.cloud.goog/v2alpha/echo
  • 运行开放的 Alpha 版:如果您想要发布可供所有客户使用的 Alpha 版本,则可以将 Alpha 版本置于现有版本所在的服务和项目中,然后更改路径。例如:

    • my-api.endpoints.my-project.cloud.goog/v2alpha/echo