Importing and Exporting APIs

Prerequisites

• Supplement the extended Swagger definition of APIs in the API file to import.
• 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 of an instance.
2. In the navigation pane on the left, choose API Connect > APIs. In the upper right corner of the page, click Import APIs.

   To import APIs, you can also choose API Connect > API Groups. In the upper right corner, click Create API Group and select Import API Design File.

3. Select a local Swagger file in YAML or JSON format.
4. Configure API import information.

   Table 1 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.
   Scope	Mandatory for Import To set to New group. Specify who can view the API group. Integration application: An API group belongs to a specific integration application. Only users who have permissions for this application can view and perform operations on the API group. All: All users in the current instance can view and perform operations on the API group.
   Integration Application	Mandatory for Scope set to Integration application. Select the API group's integration application.
   Basic Definition Overwrite	Available for Import To 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.
   Extended Definition Overwrite	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 API 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	Check the content of the imported file. Check for valid format. Format the file. Download the file to the local host. Enable Mock to use a mock backend service for importing APIs.

5. Click Import Now.

   To unify request and backend information of the imported APIs before the import, click Configure Global Settings and configure the information as prompted. Click Submit to import the APIs.

6. In the dialog box that is displayed, choose whether to publish the APIs now. If you select Now, select the environment you want to publish the APIs in.
7. Click OK.

Exporting APIs

1. Log in to the ROMA Connect console. On the Instances page, click View Console of an instance.
2. In the navigation pane on the left, choose API Connect > APIs. In the upper right corner of the page, click Export APIs.
3. Configure API export information.

   Table 2 Parameters for exporting APIs

   Parameter	Description
   API Group	Select the API group to export the APIs from.
   Environment	Select the environment to export the APIs from.
   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 basic and extended Swagger fields. Full: Both API frontend request information and backend service information. Extended: The API frontend request information, backend service information, as well as the request throttling policy and access control policy associated with the API.
   Format	Select the format of the exported API file. Options: 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 the exported API belongs to, the subdomain name of the API group will be exported.
   • If multiple independent domain names are bound to the API group the exported API belongs to, only one independent domain name will be exported randomly.