RESTAPIs在API閘道中部署 - Amazon API Gateway

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

RESTAPIs在API閘道中部署

創建後API,您必須部署它以使用戶可調用它。

若要部署API,您可以建立API部署並將其與階段產生關聯。階段是您的生命週期狀態的邏輯參考 API (例如devprodbetav2)。API階段由 API ID 和階段名稱識別。它們包含URL在您用來呼叫API. 每個階段都是部署的具名參考API,可供用戶端應用程式呼叫。

重要

每次更新時API,您都必須將重新部署API到現有階段或新階段。更新API包括修改路由、方法、整合、授權者、資源策略以及階段設定以外的任何其他內容。

隨著您的API發展,您可以繼續將其部署到不同的階段,作為不同版本的API. 您也可以將API更新部署為初期測試版本部署。這可讓您的用API戶端在相同階段透過生產版本存取生產版本,並透過初期測試版本存取更新版本。

若要呼叫已部署API,用戶端會針對的提交要求。API URL由的URL通訊協定 (S) 或 HTTP (WSS))、主機名稱、階段名稱和 (用於 RESTAPIs) 資源路徑決定。API主機名稱和階段名稱會API決定基底URL。

使用API的預設網域名稱,指定 stage REST API () 中 a (例如{stageName}) URL 的基底格式如下:

https://{restapi-id}.execute-api.{region}.amazonaws.com/{stageName}

若要API讓預設基礎URL更容易使用,您可以建立自訂網域名稱 (例如api.example.com) 來取代的預設主機名稱API。若要支援自訂網域名稱APIs下的多個,您必須將API階段對應至基本路徑。

如果自訂網域名稱為,{api.example.com}且API階段對應至自訂網域名稱下的 ({basePath}) 基本路徑,則 a URL 的基底RESTAPI會變成下列項目:

https://{api.example.com}/{basePath}

針對每個階段,您可以調整預設帳戶層級要求節流限制並啟用快取來最佳化API效能。API您也可以為 CloudTrail 或的API呼叫啟用記錄功能 CloudWatch,並且可以為後端選取用戶端憑證來驗證API要求。此外,您可以覆寫個別方法的階段層級設定,並定義階段變數,以便在執行時間將階段特定的環境內容傳遞至整合。API

階段可讓您的API. 例如,您可以將階段部署API到test舞台和prod階段,並使用test階段做為測試組建,並使用此prod階段做為穩定組建。更新通過測試之後,您就可以將 test 階段提升為 prod 階段。您可以將階段變數值重新部署API至階段,或將prod階段變數值從的階段名稱更新test為的階段變數值來完成prod

在本節中,我們將討論如何使API用API閘道主控台或呼叫閘API來部署RESTAPI。若要使用其他工具,請參閱AWS CLI或的文件AWS SDK