从 API Gateway 控制台部署 REST API - Amazon API Gateway
将 REST API 部署到阶段将 REST API 重新部署到阶段更新 REST API 部署的阶段配置为 REST API 部署设置阶段变量将阶段与不同的 REST API 部署相关联
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

从 API Gateway 控制台部署 REST API

您必须先创建 REST API，然后才能对其进行首次部署。有关更多信息，请参阅 在 Amazon API Gateway 中创建 REST API。

将 REST API 部署到阶段

借助 API Gateway 控制台，您可以创建部署并将其与新的或现有阶段相关联，从而部署 API。

注意

要在 API Gateway 中将阶段与不同的部署相关联，请改为参阅将阶段与不同的 REST API 部署相关联。

  1. 通过以下网址登录到 Amazon API Gateway 控制台：https://console.aws.amazon.com/apigateway。

  2. 在 APIs 导航窗格中，选择您要部署的 API。

  3. 在资源窗格中，选择 Deploy API (部署 API)。

  4. 对于阶段，请从以下选项中进行选择：

    1. 要创建新阶段，请选择新建阶段，然后在阶段名称中输入名称。或者，您可以在部署描述中为部署提供描述。

    2. 要选择现有阶段，请从下拉菜单中选择阶段名称。您可能需要在部署描述中为新部署提供描述。

    3. 要创建没有与阶段关联的部署，请选择没有阶段。稍后，您可以将此部署与阶段相关联。

  5. 选择部署。

将 REST API 重新部署到阶段

要重新部署 API，请执行与将 REST API 部署到阶段中相同的步骤。您可以根据需要多次重复使用同一个阶段。

更新 REST API 部署的阶段配置

部署完 API 后，您可以修改阶段设置，以启用或禁用 API 缓存、日志记录或请求限制。您还可以为后端选择客户端证书以对 API Gateway 进行身份验证，并设置阶段变量，从而在运行时将部署上下文传递至 API 集成。有关更多信息，请参阅 更新阶段设置。

重要

修改阶段设置后，您必须重新部署 API 才能使更改生效。

注意

如果启用日志记录等更新的设置要求使用新的 IAM 角色，您无需重新部署 API 即可添加所需的 IAM 角色。但是，新的 IAM 角色可能需要几分钟才能生效。在该角色生效之前，即使您已启用日志记录选项，系统也不会记录对 API 调用的跟踪。

为 REST API 部署设置阶段变量

对于部署，您可以设置或修改阶段变量，从而在运行时将特定于部署的数据传递至 API 集成。您可以在 Stage Editor (阶段编辑器) 中的 Stage Variables (阶段变量) 选项卡上执行此操作。有关更多信息，请参阅为 REST API 部署设置阶段变量中的说明。

将阶段与不同的 REST API 部署相关联

由于部署代表 API 快照，而阶段可定义到快照的路径，因此您可以选择不同的部署阶段组合，以控制用户如何调用不同版本的 API。这非常有用，例如，如果您想将 API 状态回滚至上一个部署，或者将 API 的“私有分支”合并到公有分支中，就可以这样做。

以下过程介绍如何在 API Gateway 控制台中使用阶段编辑器执行此操作。我们假定您已多次部署 API。

  1. 如果您尚未打开阶段窗格，请在主导航窗格中选择阶段。

  2. 选择要更新的阶段。

  3. 在部署历史记录选项卡上，选择您希望阶段使用的部署。

  4. 选择更改活动部署。

  5. 确认要更改活动部署，然后在设为活动部署对话框中，选择更改活动部署。