將 API 部署至閘道

本頁說明如何將 API 部署至 API Gateway。

必要條件

將 API 部署至 API Gateway 前，請務必完成下列事項：

• 按照「設定開發環境」一文所述，準備開發環境。

• 如果使用 Google Cloud CLI，請建立 API。
  附註：使用 Google Cloud 控制台時，部署 API 時會完成這個步驟，詳情請參閱下文。

• 建立 OpenAPI 規格來定義 API。

• 從 API 定義建立 API 設定。

閘道 ID 規定

下列許多 gcloud CLI 指令都需要您指定閘道 ID，格式為：GATEWAY_ID。API Gateway 會強制實行下列閘道 ID 規定：

• 長度上限為 49 個字元。
• 只能使用小寫英文字母、數字或破折號。
• 開頭不得為破折號。
• 不得包含底線。

定義已部署 API 設定的端點

將 API 設定部署至閘道時，API Gateway 會在 gateway.dev 網域中為閘道建立專屬網址。API 用戶端隨後會使用下列格式的網址，存取已部署的 API 設定：

https://GATEWAY_ID-HASH.REGION_CODE.gateway.dev

其中 GATEWAY_ID 是閘道名稱，HASH 是部署 API 時產生的專屬雜湊碼，REGION_CODE 則是部署閘道的 Cloud 位置代碼。

例如：

https://my-gateway-a12bcd345e67f89g0h.uc.gateway.dev

將 API 部署至閘道

如要將 API 部署至閘道，請按照下列步驟操作：