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

从 API Gateway 控制台部署 REST API

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

将 REST API 部署到阶段

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

注意

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

  1. 通过 https://console.amazonaws.cn/apigateway 登录 API Gateway 控制台。

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

  3. 资源导航窗格中,选择操作

  4. Actions (操作) 下拉菜单中选择 Deploy API (部署 API)

  5. Deploy API (部署 API) 对话框中,从 Deployment stage (部署阶段) 下拉列表中选择一个条目。

  6. 如果选择 [New Stage] (新阶段),请在 Stage name (阶段名称) 中键入一个名称,并选择性地在 Stage description (阶段描述)部署描述中为阶段和部署提供描述。如果选择现有的阶段,您可能需要在部署描述中为新部署提供描述。

  7. 选择部署,以将 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 控制台中使用 Stage Editor (阶段编辑器) 执行此操作。我们假定您已多次部署 API。

  1. 如果不是,在 Stage Editor (阶段编辑器)APIs 主导航窗格中,从 API 的阶段选项中选择您要更新其部署的阶段。

  2. Deployment History (部署历史) 选项卡上,选择您想要阶段使用的部署旁边的选项按钮。

  3. 选择 Change Deployment (更改部署)