更新时间:2023-12-07 GMT+08:00
分享

导出API

导出JSON或YAML格式的API。API网关支持单个API导出和批量API导出。

操作步骤

  1. 进入API网关控制台页面。
  2. 根据实际业务在左侧导航栏上方选择实例。
  1. 在左侧导航栏选择“API管理 > API分组”。单击分组名称然后单击“导出”

    或在左侧导航栏选择“API管理 > API列表”,单击“导出API”。

  2. 设置导出参数。

    表1 导出API

    信息项

    描述

    API分组

    选择待导出API所在的API分组。

    运行环境

    选择待导出API所在的环境。

    API

    默认导出API分组所在环境的所有的API,如果需要导出个别API,单击“自定义导出API”,勾选需要导出的API名称。

    API定义范围

    • 基础定义:包括API前端请求定义和响应定义,不包括后端服务定义。其中API前端请求定义除了Swagger规范定义项外,还包括API网关的一些Swagger扩展字段。适用于生成Swagger或OpenAPI格式的API文档定义。
    • 全量定义:包括API前端请求定义、后端服务定义和响应定义。适用于将API定义备份为Swagger或OpenAPI文件。
    • 扩展定义:包括API前端请求定义、后端服务定义和响应定义,还包括API关联的流量控制、访问控制等策略对象的定义。

    导出格式

    选择JSON或YAML。

    自定义版本

    为导出的API自定义版本号,如果没有指定版本号,默认使用当前时间。

    OpenAPI版本

    选择导出Swagger 2.0或OpenAPI 3.0定义的API。

  3. 单击“导出”,右侧显示导出结果,并自动下载文件。
分享:

    相关文档

    相关产品