
# 通过API设计文件导入API
ROMA Connect支持通过API设计文件导入API，支持导入YAML和JSON格式API定义文件，且文件内容应满足Swagger 2.0规范。
#### 前提条件
- 导入API前，您需要在导入的API定义文件中补全[API的Swagger扩展定义](https://support.huaweicloud.com/usermanual-roma/roma_03_2135.html)。
- 导入API前，请确保API和API分组的配额满足需求。
- 如果导入API时选择"生成新的分组"，则会使用API定义文件中的"info.title"字段值作为API分组名称。在导入API前，不能手动修改API定义文件中的"info.title"字段值。
 
#### 导入API
1. 登录[ROMA Connect控制台](https://console.huaweicloud.com/roma3)，在左侧导航栏选择"资源管理"，在实例页面单击实例，进入实例控制台。
2. 在左侧的导航栏选择"服务集成 APIC \> API列表"，在页面右上角单击"导入API"。 您也可以在"服务集成 APIC \> API分组"页面中，单击"创建API分组 \> 导入API设计文件"，导入API。
   
3. 在弹窗中选择本地要导入的YAML或JSON格式Swagger文件。
4. 在导入Swagger文件页面中，配置API导入相关信息。
   表1导入API 
   | 参数   | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
   |:---|:---|
   | 导入方式 | 选择API的导入方式。 - 生成新的分组：将API导入到一个新的API分组，导入过程中系统会自动创建一个新的API分组，并将导入的API归属到该分组。  - 选择已有分组：选择一个已有API分组，并将导入的API添加到该分组。                                                                                                                                           |
   | 可见范围 | **仅当"导入方式"选择"生成新的分组"时需要配置。** 选择API分组的可见范围。 - 集成应用：API分组归属某个集成应用，仅拥有该集成应用权限的用户可查看和操作该API分组。  - 全局：当前实例的所有用户都可查看和操作该API分组。                                                                                                       |
   | 集成应用 | **仅当"可见范围"选择"集成应用"时需要配置。** 选择API分组所属的集成应用。                                                                                                                                                                                                                                                                                                                                                                                     |
   | 是否覆盖 | **仅当"导入方式"选择"选择已有分组"时需要配置。** 当导入的API与API分组中已有的API定义冲突时，是否使用导入的API覆盖已有的API。                                                                                                                                                                                                                                                                                                                                                      |
   | 扩展覆盖 | 当导入的API中定义的扩展信息（如自定义认证、流控策略、访问控制策略等）与ROMA Connect中已有的扩展信息冲突时，是否使用导入的信息覆盖已有信息。 - 勾选：使用导入文件中定义的扩展信息覆盖掉系统已有信息。  - 不勾选：使用系统已有扩展信息，不使用导入文件中的扩展信息。                                                                                                                |
   | 导入参数 | 检查导入的文件内容。 - 单击"检查"，可检查导入文件的内容格式是否符合规范要求。  - 单击"格式化"，可对导入文件的内容进行格式化。  - 单击"下载"，可把导入的文件内容下载到本地。  - 是否启用Mock后端，表示是否使用Mock服务作为导入API的后端服务。   |
      
   
5. 单击"立即导入"。 如果您需要在导入前，对导入API的请求信息、后端服务信息进行统一配置，您可以单击"全局配置(可选)"，并根据页面向导配置API的信息。完成后单击"提交"，导入API。
   
6. 在弹窗中选择是否现在发布，若选择"现在发布"，则需要选择API要发布的环境。
7. 单击"确定"，导入API。
8. API列表显示新增导入的API，表示导入成功。
 
#### 相关文档
如导入时未发布API，可将导入成功的API[发布到环境](https://support.huaweicloud.com/usermanual-roma/roma_03_2108.html)中，以便API调用者调用。
