更新时间:2024-04-03 GMT+08:00

导入API

操作场景

API网关支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。Swagger是基于OpenAPI规范构建的开源工具,可以帮助您设计、构建、记录以及使用Rest API。

导入API支持单个API导入和批量API导入,主要取决于Swagger文件中包含的API数量。

前提条件

  • 导入API前,您需要在导入的API定义文件中补全Swagger扩展定义。如果“扩展定义”中未包含需要的定义,请提前在API网关中创建。
  • 导入API前,请确保API分组和API的配额满足需求。

操作步骤

  1. 进入共享版控制台
  2. 单击“开放API > API管理”,进入到API管理信息页面。
  3. 单击“导入API”,进入“导入API”界面。
  4. 选择如表1所示参数。

    图1 导入API
    表1 导入API

    参数名称

    说明

    导入方式

    导入方式包含以下2种:

    • 生成新的分组:将API定义导入到一个新的分组,导入过程中系统会自动创建一个新的API分组,并将导入的API归属到该分组。
    • 选择已有分组:将API定义导入到一个已有的分组,导入过程中不会删除分组中已有的API,只是将新增的API导入分组。

    API分组

    仅在选择“选择已有分组”时,需要选择API分组。

    是否覆盖

    勾选后,当导入的API名称与已有的API名称相同时,导入的API会覆盖已有的API。

    仅在选择“选择已有分组”时,需要选择是否覆盖。

    扩展覆盖

    勾选后,当导入API扩展定义项名称(ACL,流控等)与已有的策略(ACL,流控等)名称相同时,会覆盖已有的策略(ACL,流控等)。

  5. 单击“导入参数”下方的“文件”,选择待导入的API文件。

    支持yaml和json两种文件格式的API导入,界面可预览待导入API内容。
    图2 导入参数

  6. (可选)修改待导入API的全局配置。

    您可以修改全局配置,如前后端的请求配置,也可以修改具体的接口配置。

    图3 修改全局配置
    图4 修改接口配置

  7. 单击“快速上线”,完成API导入。

    导入的API不会自动发布到环境,需要您手动发布。

后续操作

将导入成功的API发布到环境中,以便API调用者调用。