在 API Gateway 中部署 REST API。 - Amazon API Gateway

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

在 API Gateway 中部署 REST API。

在 API Gateway 中,REST API 部署由 Deployment 資源代表。它類似於由 RestApi 資源表示之 API 的可執行檔。

為了讓用戶端能呼叫您的 API,您必須建立部署,並建立與其相關聯的階段。階段由 Stage 資源表示。表示 API 的快照,包括方法、整合、模型、對應範本、Lambda 授權方 (先前稱作自訂授權方) 等。當您更新 API 時,可以建立新階段與現有部署的關聯,藉此重新部署 API。我們會在「為其他 API 設置一個階段」中討論階段的建立。

使用 AWS CLI 建立部署

當您建立部署時,您可以執行個體化 Deployment 資源。您可以使用 API Gateway 主控台、AWS CLI、AWS 軟體開發套件或 API Gateway REST API 來建立部署。

若要使用 CLI 建立部署,請使用 create-deployment 命令:

aws apigateway create-deployment --rest-api-id <rest-api-id> --region <region>

在您將此部署與階段建立關聯前,都無法呼叫 API。若現已有階段,您可使用新建立的部署 ID (deploymentId) 更新階段的 <deployment-id> 屬性,來完成此操作。

aws apigateway update-stage --region <region> \ --rest-api-id <rest-api-id> \ --stage-name <stage-name> \ --patch-operations op='replace',path='/deploymentId',value='<deployment-id>'

當您第一次部署 API 時,可以同時建立階段和部署:

aws apigateway create-deployment --region <region> \ --rest-api-id <rest-api-id> \ --stage-name <stage-name>

這就是當您第一次部署 API 或將 API 重新部署到新階段時,API Gateway 主控台後端完成的操作。