从 API Gateway 导出 HTTP API - Amazon API Gateway
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

从 API Gateway 导出 HTTP API

创建 HTTP API 后,您可以从 API Gateway 导出 API 的 OpenAPI 3.0 定义。您可以选择要导出的阶段,也可以导出 API 的最新配置。还可以将导出的 API 定义导入到 API Gateway 中,以创建另一个相同的 API。要了解有关导入 API 定义的更多信息,请参阅 导入 HTTP API

使用Amazon CLI 导出阶段的 OpenAPI 3.0 定义

以下命令将名为 prod 的 API 阶段的 OpenAPI 定义导出到名为 stage-definition.yaml 的 YAML 文件。默认情况下,导出的定义文件包含 API Gateway 扩展名

aws apigatewayv2 export-api \ --api-id api-id \ --output-type YAML \ --specification OAS30 \ --stage-name prod \ stage-definition.yaml

使用Amazon CLI 导出 API 的最新更改的 OpenAPI 3.0 定义

以下命令将 HTTP API 的 OpenAPI 定义导出到名为 latest-api-definition.json 的 JSON 文件。由于命令未指定阶段,因此 API Gateway 导出 API 的最新配置,无论它是否已部署到阶段。导出的定义文件不包含 API Gateway 扩展名

aws apigatewayv2 export-api \ --api-id api-id \ --output-type JSON \ --specification OAS30 \ --no-include-extensions \ latest-api-definition.json

有关更多信息,请参阅 Amazon API Gateway 版本 2 API 参考 中的 ExportAPI

使用 API Gateway 控制台导出 OpenAPI 3.0 定义

以下过程显示了如何导出 HTTP API 的 OpenAPI 定义。

使用 API Gateway 控制台导出 OpenAPI 3.0 定义
  1. 通过以下网址登录到 Amazon API Gateway 控制台:https://console.aws.amazon.com/apigateway

  2. 选择 HTTP API。

  3. 在主导航窗格的开发下,选择导出

  4. 在以下选项中选择,以导出您的 API:

    1. 来源中,选择 OpenAPI 3.0 定义的来源。您可以选择要导出的阶段,也可以导出 API 的最新配置。

    2. 打开包括 API Gateway 扩展以包含 API 网关扩展

    3. 输出格式中,选择一种输出格式。

  5. 选择下载