Amazon API Gateway 常见问题

Amazon API Gateway 是一种完全托管的服务，可以帮助开发人员轻松发布、维护、监控和保护任意规模的 API。只需在 AWS 管理控制台中单击几下，即可创建能够充当应用程序“前门”的 API，从后端服务访问数据、业务逻辑或功能，这些后端服务包括在 Amazon Elastic Compute Cloud (Amazon EC2)、Amazon Elastic Container Service (Amazon ECS) 或 AWS Elastic Beanstalk 上运行的应用程序和在 AWS Lambda 上运行的代码或任意 Web 应用程序。Amazon API Gateway 负责管理所有任务，涉及接受和处理成千上万个并发 API 调用，包括流量管理、授权和访问控制、监控以及 API 版本管理。Amazon API Gateway 没有最低费用，也没有启动成本。对于 HTTP API 和 REST API，您只需为收到的 API 调用以及传出的数据量付费。对于 WebSocket API，您只需针对发出和收到的消息及用户/设备连接到 WebSocket API 的时间付费。

答：Amazon API Gateway 为开发人员提供了一种简单灵活的完全托管服务，此服务按使用量计费，可以处理为应用程序后端创建并操作功能强大的 API 的各个方面事务。通过 API Gateway，您可以更快速地启动新服务并降低投资，从而专注于构建核心业务服务。API Gateway 专为帮助您处理创建和管理 API 的多个方面而构建：

1) 计量。API Gateway 可帮助您制定用于计量和限制第三方开发人员访问 API 的计划。您可以依据每个 API 密钥定义一组计划、配置限制和设定配额限制。API Gateway 自动计量流向 API 的流量并允许您提取每个 API 密匙的使用数据。

2) 安全性。API Gateway 可为您提供多种授权访问 API 和控制服务操作访问的工具。API Gateway 使您可以利用多种 AWS 管理和安全工具 (比如 AWS Identity and Access Management (IAM) 和 Amazon Cognito) 来授权访问您的 API。API Gateway 可以通过 AWS 用于其自身 API 的相同方法来代表您验证签名的 API 调用。借助以 AWS Lambda 函数形式编写的自定义授权命令，API Gateway 还可以帮助您验证传入不记名令牌，从而消除后端代码的授权问题。

3) 弹性。API Gateway 可帮助您通过限制来管理流量，从而让后端操作可以抵挡流量高峰。通过缓存 API 调用的输出来避免每次都调用后端，API Gateway 还可帮助您提升 API 性能，并缩短最终用户遇到的延迟。

4) 操作监控。在 API 发布并处于使用状态后，API Gateway 便会为您提供指标控制面板，监控对您服务的调用情况。API Gateway 控制面板通过与 Amazon CloudWatch 集成为您提供各种后端性能指标，涵盖 API 调用次数、延迟数据和错误率。您可以为 API 中每种方法启用详细指标，也可以在 CloudWatch 日志中接收错误日志、访问日志或调试日志。

5) 生命周期管理。在发布了 API 之后，您通常需要构建和测试增强现有功能或添加新功能的新版本。API Gateway 使您可以同时操作每个版本的多个 API 版本和多个阶段，以便在发布新 API 版本之后，现有应用可以继续调用先前的版本。

6) 专为开发人员设计。API Gateway 使您可以快速创建 API 并为其响应分配静态内容，以降低您的应用程序的跨团队开发工作和面市时间。依赖于您的 API 的团队可以在您构建后端进程的同时开始进行开发。

7) 实时双向通信。 构建实时双向通信应用程序，如聊天应用程序、流式处理控制面板和通知，无需运行或管理任何服务器。API Gateway 可以在互连用户之间维持永久连接，并支持互连用户之间的消息传输。

Amazon API Gateway 提供了用于创建 RESTful API、HTTP API 和 REST API 的两种方法，以及用于创建 WebSocket API 的一种方法。

HTTP API：HTTP API 针对以代理方式连接到 AWS Lambda 函数或 HTTP 后端的 API 进行了优化，这使得它们非常适用于无服务器工作负载。HTTP API 目前不提供 API 管理功能。

REST API：REST API 在单个解决方案中提供 API 代理功能和 API 管理功能。 REST API 可以提供 API 管理功能，例如使用计划、API 密钥、发布和出售 API。

WebSocket API：WebSocket API 可以在互连客户端之间维持永久连接，以便启用实时消息通信。利用 API Gateway 中的 WebSocket API，您可以定义与 AWS Lambda 函数、Amazon Kinesis 或从互连客户端接收消息时调用的任何 HTTP 终端节点的后端集成。

要开始使用 HTTP API，您可以使用 Amazon API Gateway 控制台、AWS CLI、AWS 开发工具包或 AWS CloudFormation。要了解有关如何开始使用 HTTP API 的更多信息，请参阅我们的文档。

要开始使用 REST API，您可以使用 Amazon API Gateway 控制台、AWS CLI 或 AWS 开发工具包。要了解有关如何开始使用 HREST API 的更多信息，请参阅我们的文档。

您可以使用 Amazon API Gateway 中的 HTTP API 和 REST API 来构建 RESTful API。

HTTP API 针对以代理方式连接到 AWS Lambda 函数或 HTTP 后端的 API 进行了优化，这使得它们非常适用于无服务器工作负载。相较于 REST API，HTTP API 费用更低、速度更快，但目前不支持 API 管理功能。REST API 适用于需要 API 代理功能和 API 管理功能的单个解决方案。

HTTP API 非常适用于：

1. 针对 AWS Lambda 或任何 HTTP 终端节点构建代理 API
2. 构建配有 OIDC 和 OAuth 2 授权的新式 API 
3. 可能会大幅度增长的工作负载
4. 延迟敏感型工作负载

1. 希望针对构建、管理和发布 API 所需的全部功能支付单一价格的客户 

HTTP API 具有以下标准功能：支持 CORS、支持 OIDC 和 OAuth2 验证和授权以及各阶段自动部署。

可以。您可以使用 OpenAPI 3 来导入 API 定义。然后可以创建路由、集成和 API 模型。有关导入 OpenAPI 定义的更多信息，请参阅我们的文档。

要从当前 REST API 迁移到 Amazon API Gateway 中的 HTTP API，请执行以下操作：

1. 检查 HTTP API 是否具备您需要的所有功能。要查看完整功能列表，请参阅我们的文档。 
2. 打开您的 REST API，从 REST API 中导出 OpenAPI 定义
3. 打开您的 HTTP API，导入上一步导出的 OpenAPI 定义
4. 测试 API 功能是否正常
5. 用新的 URL 更新您的客户端

虽然 API 可以正常使用，但可能缺少一些功能。要确定缺少哪些功能，请查看“导入”操作部分的信息、警告和错误字段。有关从 REST API 迁移到 HTTP API 的更多信息，请参阅我们的文档。

首先，打开您的 REST API，从 REST API 中导出 OpenAPI 定义。然后，打开您的 HTTP API，导入上一步导出的 OpenAPI 定义。虽然 API 可以正常使用，但可能缺少一些功能。要确定缺少哪些功能，请查看“导入”操作部分的信息、警告和错误字段。AWS CLI 将返回有关您的 API 的信息，并且该信息将显示在“信息”和“警告”字段中。有关更多信息，请阅读我们的文档。

要开始使用，您可以使用 AWS 管理控制台、AWS CLI 或 AWS 软件开发工具包创建 WebSocket API。然后，您可以设置 WebSocket 路由，以指明后端服务，如 AWS Lambda、Amazon Kinesis 或基于消息内容调用的 HTTP 终端节点。请参阅文档以了解如何开始在 API Gateway 中使用 WebSocket API。

答：可以，通过 Amazon API Gateway 创建的所有 API 都只公开 HTTPS 终端节点。Amazon API Gateway 不支持未加密的 (HTTP) 终端节点。默认情况下，Amazon API Gateway 将内部域分配给自动使用 Amazon API Gateway 证书的 API。如果您将 API 配置为以自定义域名运行，则可以为域提供您自己的证书。

基于 Amazon API Gateway 构建的 API 可以接受通过 HTTPS 为 HTTP API、REST API 和 WebSocket API 发送的任何负载。典型数据格式包括 JSON、XML、查询字符串参数和请求标头。您可以针对 API 响应声明任何内容类型，然后使用转换模板将后端响应更改为您需要的格式。

Amazon API Gateway 可在您的账户中执行 AWS Lambda 函数，启动 AWS Step Functions 状态机，调用托管于 AWS Elastic Beanstalk 和 Amazon EC2 上的 HTTP 终端节点以及调用可通过公共 Internet 访问的基于 HTTP 的非 AWS 托管操作。API Gateway 还可让您指定映射模板以生成要返回的静态内容，帮助您在后端就绪前模拟 API。您还可以将 API Gateway 与其他 AWS 服务直接集成 – 例如，您可以在 API Gateway 中公开一种可直接向 Amazon Kinesis 发送数据的 API 方法。

API Gateway 通过 Android 和 iOS（Swift 和 Objective-C）为移动应用程序开发生成自定义 SDK，并通过 JavaScript 为 Web 应用开发生成自定义 SDK。API Gateway 还支持为 Ruby 和 Java 生成 SDK。在 API Gateway 中定义了 API 及其模型后，您便可使用 AWS 控制台或 API Gateway API 来生成和下载客户端 SDK。仅会生成 Amazon API Gateway 中的 REST API 的客户端软件开发工具包。

要了解哪些 AWS 区域提供 HTTP API、REST API 和 WebSocket API，请单击此处查看 AWS 区域表。

通过 Amazon API Gateway 控制台，您可以定义 REST API 及其关联的资源和方法，管理 API 生命周期，生成客户端 SDK 以及查看 API 指标。您还可以使用 API Gateway 控制台定义 API 使用计划、管理开发人员的 API 密匙以及配置限制和配额限制。所有相同操作均通过 API Gateway API 提供。

资源是一种类型化对象，属于您的 API 的域。每个资源可能都关联了一个数据模型，或与其他资源相关，并且可以响应不同的方法。您也可以将资源定义为变量来拦截对多个子资源的请求。

REST API 中的每种资源可以支持一个或多个标准 HTTP 方法。您将定义应每种资源应支持的动词（GET、POST、PUT、PATCH、DELETE、HEAD 和 OPTIONS）及其实施方法。例如，car 资源的 GET 操作应返回汽车列表。要将资源内的所有方法连接到单个后端终端节点，API Gateway 还支持一种特殊的“ANY”方法。

使用计划可帮助您声明针对第三方开发人员的计划，即将访问限制到特定 API、定义限制以及请求配额限制，并将这些限制与 API 密钥关联。您还可以基于每个 API 密匙提取使用数据，以分析 API 使用情况并生成账单单据。例如，您可以创建一个基础级、专业级和企业级的计划 – 您可以将基础使用计划配置为：每天仅允许 1000 次请求，而且每秒请求次数 (RPS) 最多为 5 次。

答：借助 Amazon API Gateway，每个 REST API 都可以有多个阶段。阶段用于划分 API 的开发生命周期，例如，在您构建了 API 并将其部署到开发阶段后，或者当您准备好进行生产时，您可以将其部署到生产阶段。

阶段变量可定义与某个阶段相关的配置值的密钥/值对。这些值与环境变量相似，可用于配置您的 API。例如，您可以将用于方法集成的 HTTP 终端节点定义为阶段变量，并在配置 API 时使用该变量，而不是对终端节点进行硬编码，这样一来，您就可以通过相同的 API 配置将不同终端节点用于每个阶段（如开发、测试或生产阶段）。阶段变量也可通过映射模板进行访问，可用于将配置变量传递至您的 Lambda 或 HTTP 后端。

资源策略是一种 JSON 策略文档，您可以将其附加到某个 API 来控制指定的主体（通常是 IAM 用户或角色）是否可以调用该 API。您可以使用资源策略让来自其他 AWS 账户的用户安全访问您的 API，或者只允许从指定的源 IP 地址范围或 CIDR 块调用该 API。资源策略可以与 Amazon API Gateway 中的 REST API 配合使用。

符合。您可以使用我们的开源 Swagger 导入程序工具将自己的 Swagger API 定义导入到 Amazon API Gateway。利用 Swagger 导入程序工具，您可以创建和部署新的 API，并能更新现有 API。

借助 API Gateway，您可以创建、更新和删除与 API 的每个部分关联的文档，例如方法和资源。您可以通过 AWS SDK、CLI、RESTful 调用来访问与文档关联的 API，或者通过在 API Gateway 控制台中直接编辑文档字符串来实现目标。文档还可以 Swagger 文件格式导入为 API 的一部分或单独存在，让您在不干扰 API 定义的情况下添加或更新文档。对于以 Swagger 文件格式导入或导出的文档，API Gateway 符合 Open API 规范。API Gateway 中的 REST API 支持文档。

能，您可以向 API 应用资源策略，以限制对特定 Amazon VPC 或 VPC 终端节点的访问。您还可以使用资源政策从其他账户向私有 API 提供对 Amazon VPC 或 VPC 终端节点的访问权限。