Updated on 2026-01-19 GMT+08:00

Exporting APIs

ROMA Connect allows you to export created APIs in YAML or JSON format. You can export a single API or multiple APIs in batches.

Exporting APIs

  1. Log in to the ROMA Connect console. In the navigation pane on the left, choose Resource. On the displayed page, click the instance to access its console.
  2. In the navigation pane on the left, choose API Connect > APIs. In the upper right corner of the page, click Export APIs.
  3. On the Export API page, configure API export information.
    Table 1 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.

    API

    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 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 definition file. You can select 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.
    • 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.