Importing and Exporting APIs

Overview

ROMA Connect allows you to import and export APIs using files.

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

Prerequisites

• You have supplemented the extended Swagger definition of APIs in the API file to be imported.
• Ensure that the quotas of APIs and API groups meet the requirements before importing APIs.
• If you choose New Group when importing an API, the value of the info.title field in the API definition file is used as the API group name. Before importing an API, do not change the value of the info.title field.

Importing APIs

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 > API Management. On the APIs tab page, choose More > Import API above the API list.
3. On the Import API page, configure API import information.

   Table 1 Parameters for importing APIs

   Parameter	Description
   Import To	Select the method for importing APIs. New group: Import APIs to a new API group. If you select this option, the system automatically creates an API group and imports the APIs to this group. Existing group: Select an existing API group and add the imported APIs to this group.
   Type	This parameter is mandatory only if Import To is set to New group. Select the type of the API group. Integration application: An API group belongs to a specific integration application. Only users who have permissions on the integration application can view and perform operations on the API group. Global: All users can view and perform operations on the API group.
   Integration Application	This parameter is mandatory only if Type is set to Integration application. Select the API group's integration application.
   Overwrite APIs	This parameter is available only if Import To is set to Existing group. This parameter specifies whether to overwrite the existing APIs when the imported APIs conflict with those in the existing API group.
   Overwrite Extended Definition	This parameter specifies whether to overwrite the existing extended information, such as custom authentication, request throttling policy, and access control policy, when there is a conflict between the imported APIs 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.
   Parameter Import	Select and check the imported file. Click File and select a local API file in YAML or JSON format. After the file is imported, click Check to check whether the format of the imported file is correct. Click Format to format the imported file. Click Download to download the imported file to the local host. Click Enable Mock if you want to use a mock backend for importing APIs.

4. Click Fast Import to import APIs.

   If you need to unify request and backend information of the imported APIs before the import, click Configure Global Settings and configure the information as prompted. Then click Submit to import the APIs.

   If the imported APIs have not been published in the environment, publish them manually.

Exporting APIs

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 > API Management. On the APIs tab page, choose More > Export API above the API list.
3. On the Export API page, configure API export information.

   Table 2 Parameters for exporting APIs

   Parameter	Description
   API Group	Select the API group from which APIs are to be exported.
   Environment	Select the environment in which the APIs to be exported have been published.
   APIs	Select the APIs to be exported. If this parameter is not specified, all APIs in the API group in the selected environment will be exported by default.
   API Definition	Select the scope of the API definition to be exported. Basic: Only the API frontend request information is exported. The API frontend request information includes both standard and extended Swagger 2.0 fields. Full: Both API frontend request information and backend service information are exported. Extended: The API frontend request information, backend service information, as well as the request throttling policy and access control policy associated with the API are all exported.
   Format	Select the format of the exported API file. The value can be YAML or JSON.
   Version	Enter the version of the API file to be exported. If no version is specified, the version will be set to the current time.

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

   • If no independent domain name is bound to the API group to which the exported API belongs, the subdomain name of the API group will be exported.
   • If multiple independent domain names are bound to the API group to which the exported API belongs, only one random independent domain name will be exported.