开发 API Gateway 中的 REST API
在 Amazon API Gateway 中,您可以将 REST API 构建为称为 API Gateway 资源的可编程实体的集合。例如,您可以使用 RestApi 资源表示可以包含资源实体集合的 API。
每个 Resource
实体可以具有一个或多个 Method 资源。Method
是客户端提交的传入请求,以请求参数和正文表示。它定义客户端用于访问公开 Resource
的应用程序编程接口。要将 Method
与后端端点(也称为集成端点)进行集成,可创建 Integration 资源。这会将传入的请求转发到指定的集成端点 URI。如有必要,您可以转换请求参数或请求正文来满足后端要求。
对于响应,您可以创建 MethodResponse 资源来代表客户端收到的请求响应,然后可以创建 IntegrationResponse 资源来代表后端返回的请求响应。您可以配置集成响应,以在转换后端响应数据之后将其返回给客户端,或按原样将后端响应传递给客户端。
要帮助您的客户了解 API,您还可以在创建 API 时或之后为 API 提供文档。要实现这一点,请为受支持的 API 实体添加一个 DocumentationPart 资源。
要控制客户端调用 API 的方式,请使用 IAM 权限、Lambda 授权方或 Amazon Cognito 用户池。要计量 API 的使用情况,请设置使用计划以限制 API 请求。您可在创建或更新 API 时启用这些选项。
有关如何创建 API 的介绍,请参阅教程:利用 Lambda 代理集成创建 REST API。要了解有关开发 REST API 时可能使用的 API Gateway 功能的更多信息,请参阅以下主题。这些主题包含概念信息以及您可以使用 API Gateway 控制台、API Gateway REST API、Amazon CLI 或其中一个 Amazon SDK 执行的过程。
主题
- API Gateway 中针对 REST API 的 API 端点类型
- API Gateway 中用于 REST API 的方法
- 在 API Gateway 中控制和管理对 REST API 的访问
- 针对 API Gateway 中的 REST API 的集成
- 针对 API Gateway 中的 REST API 的请求验证
- 针对 API Gateway 中 REST API 的数据转换
- 针对 API Gateway 中 REST API 的网关响应
- 针对 API Gateway 中的 REST API 的 CORS
- 针对 API Gateway 中的 REST API 的二进制媒体类型
- 调用 API Gateway 中的 REST API
- 在 API Gateway 中使用 OpenAPI 开发 REST API