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

通过导入 Swagger 定义设置边缘优化的 API

通过指定相应 API Gateway API 实体的 Swagger 定义并将 Swagger 定义导入 API Gateway,您可以在 API Gateway 中设置 API。

以下 Swagger 定义描述了一个简单 API,该 API 仅公开与后端中 PetStore 网站的 HTTP 终端节点集成的 GET / 方法,并返回 200 OK 响应。

{ "swagger": "2.0", "info": { "title": "Simple PetStore (Swagger)" }, "schemes": [ "https" ], "paths": { "/pets": { "get": { "responses": { "200": { "description": "200 response" } }, "x-amazon-apigateway-integration": { "responses": { "default": { "statusCode": "200" } }, "uri": "http://petstore-demo-endpoint.execute-api.com/petstore/pets", "passthroughBehavior": "when_no_match", "httpMethod": "GET", "type": "http" } } }, "/pets/{petId}": { "get": { "parameters": [ { "name": "petId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "200 response" } }, "x-amazon-apigateway-integration": { "responses": { "default": { "statusCode": "200" } }, "requestParameters": { "integration.request.path.id": "method.request.path.petId" }, "uri": "http://petstore-demo-endpoint.execute-api.com/petstore/pets/{id}", "passthroughBehavior": "when_no_match", "httpMethod": "GET", "type": "http" } } } } }

以下过程介绍了如何使用 API Gateway 控制台将这些 Swagger 定义导入到 API Gateway 中。

使用 API Gateway 控制台导入简单 API 的 Swagger 定义

  1. 登录 API Gateway 控制台。

  2. 选择 Create API

  3. 选择 Import from Swagger

  4. 如果您已将上述 Swagger 定义保存在文件中,请选择 Select Swagger File。此外,您还可以复制 Swagger 定义并将其粘贴到导入文本编辑器中。

  5. 选择 Import 以便完成 Swagger 定义的导入。

要使用 API Gateway REST API 导入 Swagger 定义,请调用 restapi:import 操作,将上述 Swagger 定义作为负载提供。有关更多信息,请参阅 restapi:import 主题的备注部分中的示例。

要使用 AWS CLI 导入 Swagger 定义,请将 Swagger 定义保存到一个文件中,然后运行以下命令 (假设您使用 us-west-2 地区,Swagger 文件的绝对路径为 file:///path/to/API_Swagger_template.json):

aws apigateway import-rest-api --body 'file:///path/to/API_Swagger_template.json' --region us-west-2