RESTAPI在API閘道中建立部署 - Amazon API Gateway
建立部署API部署的後續步驟

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

RESTAPI在API閘道中建立部署

在API閘道中，RESTAPI部署由部署資源表示。它類似於由RestApi資源表示API的可執行文件。

若要讓用戶端呼叫您的API，您必須建立部署並將階段與其產生關聯。階段由 Stage 資源表示。它代表的快照API，包括方法、整合、模型、對應範本和 Lambda 授權者 (以前稱為自訂授權者)。更新時API，您可以API透過將新階段與現有部署關聯來重新部署。我們會在「在 API Gateway RESTAPI中設定 的階段」中討論階段的建立。

建立部署

下列程序顯示如何建立 RESTAPI.

AWS Management Console

在第一次部署RESTAPI之前，您必須先建立它。如需詳細資訊，請參閱 在 API Gateway RESTAPIs中開發。

APIGateway 主控台可讓您API透過建立部署並將其與新的或現有階段建立關聯來部署。

  1. 請在 https://console.aws.amazon.com/apigateway 登入API閘道主控台。

  2. 在APIs功能窗格中，選擇API您要部署的。

  3. 在 [資源] 窗格中，選擇 [部署] API。

  4. 針對階段，請從下列項目中選取：

    1. 若要建立新階段，請選取新階段，然後在階段名稱中輸入名稱。或者，您可以在部署說明中提供部署的說明。

    2. 若要選擇現有階段，請從下拉式選單選取階段名稱。建議您在部署說明中提供新部署的說明。

    3. 若要建立與階段沒有關聯的部署，請選取無階段。您之後可以再將此部署與階段建立關聯。

  5. 選擇部署。

AWS CLI

當您建立部署時，您可以執行個體化 Deployment 資源。您可以使用API閘道主控台 AWS CLI、 AWS SDK、或API閘道RESTAPI來建立部署。

若要使用建CLI立部署，請使用建立部署指令：

 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 Gateway 主控台幕後完成的操作。API

若要重新部署API，請執行相同的步驟。您可視需要重複使用相同階段，次數不限。

API部署的後續步驟

以下是API部署的後續步驟。

修改階段設定

部署之API後，您可以修改階段設定，以啟用或停用API快取、記錄或要求節流。您也可以為後端選擇用戶端憑證來驗證API閘道，並設定階段變數，以便在執行時間將部署內容傳遞至API整合。如需更多資訊，請參閱修改階段設定

修改階段設定之後，您必須重新部API署，變更才會生效。

注意

如果更新的設定 (例如啟用記錄) 需要新IAM角色，您可以新增必要的IAM角色，而無需重新部API署. 不過，新IAM角色可能需要幾分鐘的時間才會生效。在此之前，即使您已啟用記錄選項，也不會記錄API呼叫的痕跡。

選擇不同的部署階段組合

由於部署代表API快照，而且階段定義了快照的路徑，因此您可以選擇不同的部署階段組合，以控制使用者呼叫不同版本的. API 例如，當您想要API將API狀態回滾到先前的部署或將「私有分支」合併到公共部署中時，此功能非常有用。

下列程序顯示如何使用API閘道主控台中的階段編輯器來執行此作業。假設您必須部署API多次。

  1. 如果您尚未在階段窗格中，請在主導覽窗格中選擇階段。

  2. 選取您要更新的階段。

  3. 在部署歷史記錄索引標籤上，選擇要讓階段使用的部署。

  4. 選擇變更作用中部署。

  5. 確認您要變更作用中部署，然後在設為作用中部署對話方塊中選擇變更作用中部署。

將部署特定資料傳遞給您的. API

對於部署，您可以設定或修改階段變數，以便在執行時間將部署特定資料傳遞至API整合。您可以在 Stage Editor (階段編輯器) 的 Stage Variables (階段變數) 標籤上執行這項操作。如需詳細資訊，請參閱「RESTAPI在API閘道中使用階段變數」中的說明。