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

将边缘优化的 API 导入 API Gateway

您可以导入 API 的 OpenAPI 定义文件,在 OpenAPI 文件之外通过指定 EDGE 终端节点类型作为导入操作的附加输入,创建新的边缘优化的 API。您可以使用 API Gateway 控制台、AWS CLI、AWS 软件开发工具包或 API Gateway REST API 执行此操作。

使用 API Gateway 控制台导入边缘优化的 API

要导入边缘优化的 API 终端节点类型的 API,请使用 API Gateway 控制台执行以下操作:

  1. 登录 API Gateway 控制台,然后选择 + Create API

  2. Create new API (创建新 API) 下选择 Import from OpenAPI (从 OpenAPI 导入) 选项。

  3. 复制 API 的 OpenAPI 定义并粘贴到代码编辑器中,或者选择 Select OpenAPI File (选择 OpenAPI 文件) 以从本地驱动器加载 OpenAPI 文件。

  4. 设置下,对于 Endpoint Type (终端节点类型),选择 Edge optimized

  5. 选择导入以便开始 OpenAPI 定义的导入。

使用 AWS CLI 导入边缘优化的 API

要使用 AWS CLI 从 OpenAPI 定义文件导入 API 创建新的边缘优化的 API,请使用 import-rest-api 命令,如下所示:

aws apigateway import-rest-api \ --fail-on-warnings \ --body 'file://path/to/API_OpenAPI_template.json'

或者使用到 endpointConfigurationTypesEDGE 查询字符串参数的明确规范:

aws apigateway import-rest-api \ --endpointConfigurationTypes 'EDGE' \ --fail-on-warnings \ --body 'file://path/to/API_OpenAPI_template.json'

使用 API Gateway REST API 导入边缘优化的 API

要使用 API Gateway REST API 通过导入 OpenAPI 定义文件创建区域 API,请调用以下 restapi:import 链接关系:

POST /restapis?mode=import&failonwarnings=true Host: apigateway.us-west-2.amazonaws.com Content-Type:application/json Content-Length: ... { //OpenAPI definition }

或者使用到 endpointConfigurationTypesEDGE 查询字符串参数的明确规范:

POST /restapis?mode=import&failonwarnings=true&endpointConfigurationTypes=EDGE Host: apigateway.us-west-2.amazonaws.com Content-Type:application/json Content-Length: ... { //OpenAPI definition }