更新时间:2024-09-29 GMT+08:00
分享

导入导出自定义后端

ROMA Connect支持通过文件的方式导入导出自定义后端。

  • 导入自定义后端:支持导入YAML和JSON格式API定义文件,且文件内容应满足Swagger 2.0规范。
  • 导出自定义后端:支持导出YAML和JSON格式API定义文件。

前提条件

  • 导入自定义后端前,您需要在导入的API定义文件中补全自定义后端的Swagger扩展定义
  • 导入自定义后端前,请确保自定义后端的配额满足需求。
  • 导入自定义后端时,导入的API定义文件大小最大为3MB。
  • 导出自定义后端时,导出的API定义文件大小最大为50MB。如果导出的API定义文件超过50MB,则多出来的自定义后端将不导出。

导入自定义后端

  1. 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。
  2. 在左侧的导航栏选择“服务集成 APIC > 自定义后端”,在“后端列表”页签下单击“导入后端”。
  3. 在导入后端页面中,配置后端导入相关信息。
    表1 导入自定义后端

    参数

    说明

    API定义覆盖

    当导入的自定义后端与已有的自定义后端定义冲突时,是否使用导入的自定义后端覆盖已有的自定义后端。

    扩展定义覆盖

    当导入的自定义后端中定义的扩展信息(如流控策略、访问控制策略等)与ROMA Connect中已有的扩展信息冲突时,是否使用导入的信息覆盖已有信息。

    • 勾选:使用导入文件中定义的扩展信息覆盖掉系统已有信息。
    • 不勾选:使用系统已有扩展信息,不使用导入文件中的扩展信息。

    Swagger

    单击“选择Swagger文件”,选择本地要导入的YAML或JSON格式Swagger文件。

    导入文件后,ROMA Connect支持在线预览和修改导入的文件内容。

  4. 单击“确定”,导入后端。

    界面右侧显示导入结果,“success”字段中包含了导入成功的后端,“failure”字段中包含了导入失败的后端、错误码和错误信息。

    新导入的自定义后端,非覆盖导入后状态会显示为“开发中”。

导出自定义后端

  1. 登录ROMA Connect控制台,在“实例”页面单击实例上的“查看控制台”,进入实例控制台。
  2. 在左侧的导航栏选择“服务集成 APIC > 自定义后端”,在“后端列表”页签下单击“导出后端”。

    仅状态为“开发中”的后端支持导出。

  3. 在导出后端页面中,配置导出相关信息。
    表2 导出自定义后端

    参数

    说明

    导出类型

    选择自定义后端的导出类型。

    • 全量导出:导出所有自定义后端。

      若不同集成应用下的自定义后端有相同的请求路径,则相同请求路径的自定义后端只能导出其中的一个。

    • 集成应用:导出指定集成应用下的自定义后端。

    集成应用

    仅当“导出类型”选择“集成应用”时需要配置。

    选择要导出的自定义后端所属的集成应用。

    API定义范围

    选择要导出的API定义信息范围,仅支持选择“全量定义”,即导出自定义后端的全部请求和服务信息。

    导出格式

    选择导出的API定义文件格式,可选择“YAML”和“JSON”。

  4. 单击“导出”,导出API定义文件到本地,界面右侧显示导出的文件内容结果。

相关文档