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

Amazon API Gateway 概念

API Gateway

API Gateway 是一项 AWS 服务,支持以下操作:

  • 创建、部署和管理 REST 应用程序编程接口 (API) 以公开后端 HTTP 终端节点、AWS Lambda 函数或其他 AWS 服务。

  • 创建、部署和管理 WebSocket API 以公开 AWS Lambda 函数或其他 AWS 服务。

  • 通过前端 HTTP 和 WebSocket 终端节点调用公开的 API 方法。

API Gateway REST API

与后端 HTTP 终端节点、Lambda 函数或其他 AWS 服务集成的 HTTP 资源与方法的集合。这种集合可以在一个或多个阶段中部署。通常情况下,根据应用程序逻辑将 API 资源组织成资源树形式。每个 API 资源均可公开一个或多个 API 方法,这些方法具有受 API Gateway 支持的唯一 HTTP 命令动词。

API Gateway WebSocket API

与后端 HTTP 终端节点、Lambda 函数或其他 AWS 服务集成的 WebSocket 路由和路由键的集合。这种集合可以在一个或多个阶段中部署。API 方法通过可以与注册的自定义域名关联的前端 WebSocket 连接进行调用。

API 部署

API Gateway API 的时间点快照。要使客户端可用,必须将部署与一个或多个 API 阶段关联。

API 开发人员

拥有 API Gateway 部署的 AWS 账户(例如还支持编程访问的服务提供方。)

API 终端节点

API Gateway 中部署到特定区域的 API 的主机名。主机名的格式是 {api-id}.execute-api.{region}.amazonaws.com。支持以下类型的 API 终端节点:

API 密钥

一个字母数字字符串,API Gateway 通过它标识使用您的 REST 或 WebSocket API 的应用程序开发人员。API Gateway 可以代表您生成 API 密钥,也可以从 CSV 文件中导入 API 密钥。您可以将 API 密钥与 Lambda 授权方使用计划一起使用来控制对 API 的访问。

请参阅 API 终端节点

API 所有者

请参阅 API 开发人员

API 阶段

对您的 REST 或 WebSocket API 生命周期状态(例如,“dev”、“prod”、“beta”、“v2”)的逻辑引用。API 阶段由 API ID 和阶段名称标识。

应用程序开发人员

应用程序创建者,可能拥有也可能不拥有 AWS 账户并与您(API 开发人员)部署的 API 交互。应用程序开发人员是您的客户。应用程序开发人员通常由 API 密钥标识。

回调 URL

当新客户端通过 WebSocket 连接进行连接时,您可以调用 API Gateway 中的集成来存储客户端的回调 URL。然后,您可以使用该回调 URL 从后端系统向客户端发送消息。

开发人员门户

一个能让您的客户注册、发现和订阅 API 产品(API Gateway 使用计划),管理其 API 密钥以及查看 API 使用指标的应用程序。

边缘优化的 API 终端节点

一个部署到指定区域同时使用 CloudFront 分配以方便客户端从全 AWS 区域进行常规访问的 API Gateway API 的默认主机名。API 请求将路由至最近的 CloudFront 接入点 (POP),通常可改进不同地理位置客户端的连接时间。

请参阅 API 终端节点

集成请求

API Gateway 中的 WebSocket API 路由或 REST API 方法的内部接口,在其中您会将路由请求的正文或方法请求的参数和正文映射到后端所需的格式。

集成响应

API Gateway 中的 WebSocket API 路由或 REST API 方法的内部接口,在其中您会将从后端接收到的状态代码、标头和负载映射到返回到客户端应用程序的响应格式。

映射模板

使用 Velocity 模板语言 (VTL) 表示的脚本,这些脚本用于将请求正文从前端数据格式转换为后端数据格式,或将响应正文从后端数据格式转换为前端数据格式。映射模板可以在集成请求中或在集成响应中指定。它们可以将运行时提供的数据引用为上下文和阶段变量。映射可以像身份转换一样简单,它通过集成将标头或正文从客户端按原样传递到请求的后端。对于响应也是如此,在其中负载从后端传递到客户端。

方法请求

API Gateway 中 REST API 方法的公共接口,用于定义应用程序开发人员通过 API 访问后端时必须在请求中发送的参数和正文。

方法响应

REST API 的公共接口,定义应用程序开发人员期望在 API 的响应中收到的状态代码、标头和正文模型。

模拟集成

在模拟集成中,API 响应直接从 API Gateway 生成,而无需集成后端。作为 API 开发人员,您可以决定 API Gateway 响应模拟集成的方式。为此,您可以配置方法的集成请求和集成响应,以将响应与给定的状态代码相关联。

模型

指定请求或响应负载的数据结构的数据架构。生成 API 的强类型的开发工具包时需要使用模型。它还用于验证负载。模型可以方便地用于生成示例映射模板,以便开始创建生产映射模板。虽然模型很有用,但不是创建映射模板所必需的。

私有 API

请参阅私有 API 终端节点

私有 API 终端节点

一个通过接口 VPC 终端节点公开的 API 终端节点,能让客户端安全地访问 VPC 内的私有 API 资源。私有 API 与公有 Internet 隔离,只能使用已授予访问权限的 API Gateway 的 VPC 终端节点访问它们。

私有集成

一种 API Gateway 集成类型,供客户端通过私有 REST API 终端节点访问客户 VPC 中的资源,而不向公有 Internet 公开资源。

代理集成

用于 REST 或 WebSocket API 的简化的 API Gateway 集成配置。您可以将代理集成设置为 HTTP 代理集成或 Lambda 代理集成。对于 HTTP 代理集成,API Gateway 在前端与 HTTP 后端之间传递整个请求和响应。对于 Lambda 代理集成,API Gateway 将整个请求作为输入发送到后端 Lambda 函数,API Gateway 然后将 Lambda 函数输出转换为前端 HTTP 响应。在 REST API 中,代理集成最常与代理资源一起使用,以“贪婪”路径变量 (例如 {proxy+}) 与“捕获所有”ANY 方法相结合的方式表示。

区域 API 终端节点

部署到指定区域并旨在服务于同一 AWS 区域中的 EC2 实例等客户端的 API 的主机名。API 请求直接以区域特定的 API Gateway 为目标而不经过任何 CloudFront 分配。对于区域内请求,区域性终端节点会绕过到 CloudFront 分配的不必要往返行程。此外,您可以在区域性终端节点上应用基于延迟的路由,从而使用相同的区域性 API 终端节点配置将 API 部署到多个区域,为每个已部署的 API 设置相同的自定义域名,以及在 Route 53 中配置基于延迟的 DNS 记录以将客户端请求路由到延迟最低的区域。

请参阅 API 终端节点

路由

API Gateway 中的 WebSocket 路由用于根据消息内容将传入消息定向到特定集成,例如 AWS Lambda 函数。在定义 WebSocket API 时,指定路由键和集成后端。路由键是消息正文中的一种属性。当路由键在传入消息中匹配时,将会调用集成后端。还可以为不匹配的路由键设置默认路由,或者设置默认路由来指定一个将消息按原样传递给执行路由和处理请求的后端组件的代理模型。

路由请求

API Gateway 中 WebSocket API 方法的公共接口,定义了应用程序开发人员在通过 API 访问后端时必须在请求中发送的正文。

路由响应

WebSocket API 的公共接口,定义应用程序开发人员期望从 API Gateway 收到的状态代码、标头和正文模型。

使用计划

使用计划可以提供能够访问一个或多个部署的 REST 或 WebSocket API 的选定 API 客户端。您可以通过使用计划来配置限制和配额限制,这些限制会应用到单独的客户端 API 密钥。

WebSocket 连接

API Gateway 在客户端和 API Gateway 本身之间维护持久连接。API Gateway 和后端集成(例如 Lambda 功能)之间没有持久连接;将会根据从客户端收到的消息内容,在需要时调用后端服务。