規劃您的 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 測試版,您可以將該測試版放在與現有版本相同的服務和專案中,然後變更路徑。例如:

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