Amazon API Gateway
开发人员指南
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

在 API Gateway 中部署 REST API

在 API Gateway 中,REST API 以部署资源来表示部署。它类似于由 RestApi 资源表示的 API 的可执行文件。要让客户端调用 API,您必须创建部署并将阶段与其关联。阶段由阶段资源表示,代表 API 的快照,包括方法、集成、模型、映射模板、Lambda 授权方(以前称为自定义授权方)等。更新 API 时,您可以通过将新阶段与现有部署关联来重新部署 API。我们在在 API Gateway 中设置阶段中介绍了创建阶段。

使用 AWS CLI 创建部署

创建部署相当于实例化部署资源。您可以使用 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 (<deployment-id>) 更新阶段的 deploymentId 属性来完成此操作。

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 控制台在后台完成的任务。

本页内容: