导入导出API

概述

ROMA Connect支持通过文件的方式导入导出API。

• 导入API：支持导入YAML和JSON格式API定义文件，且文件内容应满足Swagger 2.0规范。
• 导出API：支持导出YAML和JSON格式API定义文件。

前提条件

• 导入API前，您需要在导入的API定义文件中补全API的Swagger扩展定义。
• 导入API前，请确保API和API分组的配额满足需求。
• 如果导入API时选择“生成新的分组”，则会使用API定义文件中的“info.title”字段值作为API分组名称。在导入API前，不能手动修改API定义文件中的“info.title”字段值。

导入API

1. 登录ROMA Connect控制台，在“实例”页面单击实例上的“查看控制台”，进入实例控制台。
2. 在左侧的导航栏选择“服务集成 APIC > API管理”，在“API列表”页签上方单击“更多 > 导入API”。
3. 在导入API页面中，配置API导入相关信息。

   表1 导入API

   参数	配置说明
   导入方式	选择API的导入方式。 生成新的分组：将API导入到一个新的API分组，导入过程中系统会自动创建一个新的API分组，并将导入的API归属到该分组。 选择已有分组：选择一个已有API分组，并将导入的API添加到该分组。
   类型	仅当“导入方式”选择“生成新的分组”时需要配置。 选择API分组的类型。 集成应用：API分组归属某个集成应用，仅拥有该集成应用权限的用户可查看和操作该API分组。 全局：所有用户都可查看和操作该API分组。
   集成应用	仅当“类型”选择“集成应用”时需要配置。 选择API分组所属的集成应用。
   是否覆盖	仅当“导入方式”选择“选择已有分组”时需要配置。 当导入的API与API分组中已有的API定义冲突时，是否使用导入的API覆盖已有的API。
   扩展覆盖	当导入的API中定义的扩展信息（如自定义认证、流控策略、访问控制策略等）与ROMA Connect中已有的扩展信息冲突时，是否使用导入的信息覆盖已有信息。 勾选：使用导入文件中定义的扩展信息覆盖掉系统已有信息。 不勾选：使用系统已有扩展信息，不使用导入文件中的扩展信息。
   导入参数	选择并检查导入文件。 单击“文件”，选择本地要导入的YAML或JSON格式API定义文件。 导入文件后，单击“检查”，可检查导入文件的内容格式是否符合规范要求。 单击“格式化”，可对导入文件的内容进行格式化。 单击“下载”，可把导入的文件内容下载到本地。 是否启用Mock后端，表示是否使用Mock服务作为导入API的后端服务。

4. 单击“快速导入”，导入API。

   如果您需要在导入前，对导入API的请求信息、后端服务信息进行统一配置，您可以单击“全局配置”，并根据页面向导配置API的信息。完成后单击“提交”，导入API。

   导入的API未发布到环境，您需要手动发布API。

导出API

1. 登录ROMA Connect控制台，在“实例”页面单击实例上的“查看控制台”，进入实例控制台。
2. 在左侧的导航栏选择“服务集成 APIC > API管理”，在“API列表”页签上方单击“更多 > 导出API”。
3. 在导出API页面中，配置API导出相关信息。

   表2 导出API

   参数	配置说明
   API分组	选择要导出API所在的API分组。
   运行环境	选择要导出API所在的发布环境。
   API	自定义选择要导出的API。若不配置，则默认导出API分组在所选环境下的所有的API。
   API定义范围	选择要导出的API定义信息范围。 基础定义：仅导出API前端请求信息，不包括后端服务信息。其中API前端信息除了Swagger 2.0规范定义项外，还包括ROMA Connect的一些Swagger扩展字段。 全量定义：包括API前端请求信息和后端服务信息。 扩展定义：包括API前端请求信息、后端服务信息，以及API关联的流量控制策略、访问控制策略信息。
   导出格式	选择导出的API定义文件格式，可选择“YAML”和“JSON”。
   自定义版本	填写导出的API定义文件版本号，如果没有指定版本号，默认使用当前时间作为版本号。

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

   • 若导出API所在的API分组未绑定独立域名，则导出API分组的子域名。
   • 若导出API所在的API分组绑定了多个独立域名，则只随机导出其中的一个独立域名。