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 completed the Swagger extended definitions for custom backends in the API file to be imported.
• Before importing a custom backend, ensure that there is sufficient custom backend quota.
• When importing a custom backend, the maximum size of a target API definition file is 3 MB.
• When exporting a custom backend, the maximum size of a target API definition file is 50 MB. If the size of the target API definition file exceeds 50 MB, the excess part will not be exported.

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 Backends. On the Backends tab page, click Import above the backend list.
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, such as the request throttling policy and access control policy, when there is a conflict between the imported custom backends and ROMA Connect. Enable: The existing extended information is overwritten with that defined in the imported file. Disable: The existing extended information is used, rather than that in the imported file.
   Swagger	Click Select and select a local API file in YAML or JSON format. After the file is imported, 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, the 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 Backends. On the Backends tab page, click Export above the backend list.

   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	Specify the type of API definition to be exported. Only Full is supported, indicating that all requests and service information of backends are exported.
   Scope	Specify the scope of custom backends to be exported. All: All custom backends are exported. Within integration application: Custom backends of an integration application are exported. NOTE: When you select All, only a random one of the custom backends with the same request path among different integration applications can be exported.
   Integration Application	This parameter is mandatory only if Scope is set to Within integration application. Select the integration application to which the custom backends belongs.
   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.