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

使用示例构建 API Gateway API

为了帮助您开始使用基本工作流程来构建并测试 API Gateway API,您可以使用 Amazon API Gateway 控制台来创建并测试与 PetStore 网站进行 HTTP 集成的简单 API。API 定义预配置为 Swagger 2.0 文件。在将 API 定义加载到 API Gateway 中后,您可以使用 API Gateway 控制台来检查 API 的基本结构或直接部署并测试 API。

示例 API 支持客户端使用以下方法来访问 HTTP 后端网站 http://petstore-demo-endpoint.execute-api.com/petstore

  • GET /:用于对未与任何后端终端节点集成的 API 根资源进行读取访问。API Gateway 会使用 PetStore 网站的概述进行响应。这是 MOCK 集成类型的示例。

  • GET /pets:用于对已与名称相同的后端 /pets 资源集成的 API /pets 资源进行读取访问。后端会返回 PetStore 中的可用宠物的页面。这是 HTTP 集成类型的示例。集成终端节点的 URL 为 http://petstore-demo-endpoint.execute-api.com/petstore/pets

  • POST /pets:用于对已与后端 /petstore/pets 资源集成的 API /pets 资源进行写入访问。收到正确请求后,后端会将指定的宠物添加到 PetStore 中并将结果返回给调用方。该集成也是 HTTP 集成。

  • GET /pets/{petId}:用于对指定为传入请求 URL 的路径变量的 petId 值标识的宠物进行读取访问。此方法也具有 HTTP 集成类型。后端会返回在 PetStore 中找到的指定宠物。后端 HTTP 终端节点的 URL 是 http://petstore-demo-endpoint.execute-api.com/petstore/pets/n,其中 n 是一个用作所查询宠物的标识符的整数。

API 支持通过 MOCK 集成类型的 OPTIONS 方法进行 CORS 访问。API Gateway 会返回支持 CORS 访问所需的标头。

另请参阅

使用 API Gateway 自定义授权方在 Amazon API Gateway 中部署 API

本页内容: