Importing and Exporting Custom Backends

Overview

ROMA Connect allows you to import and export custom backends using a file.

• Importing custom backends: API files in YAML and JSON formats can be imported, and the file content must comply with the Swagger 2.0 specifications.
• Exporting custom backends: API files in YAML and JSON formats can be exported.

Prerequisites

• You have supplemented the extended Swagger definition of custom backends in the API file to be imported.
• Before importing a custom backend, ensure that the quota of custom backends meets the requirements.

Importing Custom Backends

1. Log in to the ROMA Connect console. On the Instances page, click View Console next to a specific instance.
2. In the navigation pane on the left, choose API Connect > Custom Backend. On the Backends tab page, click Import.
3. On the Import Backend page, configure backend import information.

   Table 1 Parameters for importing backends

   Parameter	Description
   Overwrite Basic Definition	This parameter specifies whether to overwrite the existing backends when the imported backends conflict with the existing ones.
   Overwrite Extended Definition	This parameter specifies whether to overwrite the existing extended information when the extended information (such as request throttling policy and access control policy) defined in the imported backend conflicts with the existing extended information in ROMA Connect. If you select this option, the system overwrites the existing information with the extended information defined in the imported file. If you do not select this option, the existing extended information in the system is used, rather than the extended information in the imported file.
   Swagger	Click Select and select a local API file in YAML or JSON format. After the file is imported, you can preview and modify the file online.

4. Click Import.

   The import result is displayed in the right pane. The success field contains the backends that are successfully imported, and the failure field contains the backends that fail to be imported, error codes, and error information.

Exporting Custom Backends

1. Log in to the ROMA Connect console. On the Instances page, click View Console next to a specific instance.
2. In the navigation pane on the left, choose API Connect > Custom Backend. On the Backends tab page, click Export All.

   Only backends in the Developing state can be exported.

3. On the Export Backend page, configure backend export information.

   Table 2 Parameters for exporting backends

   Parameter	Description
   API Definition	Select the scope of the API definition to be exported. Only Full is supported, indicating that all requests and service information of backends are exported.
   Export Scope	Select the export scope of the custom backend. All backends: Export all custom backends. Based on integration applications: Export the custom backends under the specified integration application. NOTE: If All backends is selected for Export Scope and the custom backends of different integration applications have the same request path, only one of the custom backends with the same request path can be exported.
   Integration Application	This parameter is mandatory only if Based on integration applications is selected for Export Scope. Select the integration application to which the custom backends to export belong.
   Format	Select the format of the exported API file. The value can be YAML or JSON.

4. Click Export to export the API file to a local directory. The content of the exported file is displayed in the right pane.