Skip to main content

Introduction

Functions​

Migrate existing projects easily with support for importing from OpenAPI (Swagger), Postman, .har, apiDoc, RAML, JMeter, I/O Docs, WADL, Google Discovery and other data formats.

Two data import methods are supported: manual import and automatic import.

Manually Import​

Open the Settings panel, click Import, and choose to import files or URLs.

Taking Apidog format as an example, the importable content includes: APIs, data model, environment, test case, test suite.

Note

  1. Importing OpenAPI/Swagger format only includes API, data model, environment

  2. Importing Postman format only includes API

Manual Import-Advanced Settings​

When Matching the Same API​

  • Overwrite all fields: When the unique identifier of two APIs is the same, the new file will overwrite the old file.

  • Do not import: When the unique identifier of two APIs is the same, the new file will not be imported.

  • Keep both: When the unique identifier of two APIs is the same, the new file will be imported, and the old file will not be deleted.

When Matching the Same Document​

  • Overwrite: When the unique identifier of two documents is the same, the new file will overwrite the old file.

  • Do not import: When the unique identifier of two documents is the same, the new file will not be imported.

  • Keep both: When the unique identifier of two documents is the same, the new file will be imported, and the old file will not be deleted.

When Matching the Same Data Model​

  • Overwrite: When the unique identifier of two data models is the same, the new file will overwrite the old file.

  • Do not import: When the unique identifier of two data models is the same, the new file will not be imported.

  • Keep both: When the unique identifier of two data models is the same, the new file will be imported, and the old file will not be deleted.

When Matching the Same Environment​

  • Overwrite: When the unique identifier of two environments is the same, the new file will overwrite the old file.

  • Do not import: When the unique identifier of two environments is the same, the new file will not be imported.

  • Keep both: When the unique identifier of two environments is the same, the new file will be imported, and the old file will not be deleted.

Automatic Import​

Apidog also supports automatic import of API data format files. After setting up the automatic import, Apidog will automatically import the specified file or URL at the specified time.

Automatic Import-Advanced Settings​

When Matching the Same API​

  • Overwrite all fields: When the unique identifier of two API is the same, the new file will overwrite the old file.

  • Do not import: When the unique identifier of two API is the same, the new file will not be imported.

  • Keep both: When the unique identifier of two API is the same, the new file will be imported, and the old file will not be deleted.

When Matching the Same Document​

  • Overwrite: When the unique identifier of two documents is the same, the new file will overwrite the old file.

  • Do not import: When the unique identifier of two documents is the same, the new file will not be imported.

  • Keep both: When the unique identifier of two documents is the same, the new file will be imported, and the old file will not be deleted.

When Matching the Same Data Model​

  • Overwrite: When the unique identifier of two data models is the same, the new file will overwrite the old file.

  • Do not import: When the unique identifier of two data models is the same, the new file will not be imported.

  • Keep both: When the unique identifier of two data models is the same, the new file will be imported, and the old file will not be deleted.

When Matching the Same Environment​

  • Overwrite: When the unique identifier of two environments is the same, the new file will overwrite the old file.

  • Do not import: When the unique identifier of two environments is the same, the new file will not be imported.

  • Keep both: When the unique identifier of two environments is the same, the new file will be imported, and the old file will not be deleted.

When two document names are the same, the new file will overwrite the old file.

  • Do not import: When two document names are the same, the new file will not be imported.
  • Keep both: When two document names are the same, the new file will be imported, and the old file will not be deleted.

Import to Directory​

Support importing files to specific directories.

Import API Test Cases​

When the switch is turned on, the API Test Cases under the selected API will be selected by default, and you can also select the corresponding API Test Cases in the Import Preview.

Automatic Import​

Open the "Setings" panel, click the "Import Data (Auto Sync)" button, and set the scheduled import frequency strategy. Supports synchronizing data sources in formats such as OpenAPI (Swagger), apiDoc, Apidog, and Knife4j.

After creating an automatic import strategy, click the "Import Now" button, and the system will start the synchronization task. Clicking the "Save" option means that the set strategy is only temporarily stored, and it will be executed regularly according to the import frequency in the strategy.

If you modify an existing automatic import strategy in the data source, click "Details" → "Save" → "Import Now". If you modify the import strategy but do not save it, the system will execute according to the strategy before the modification.

Note

Only administrators have the permission to import data, and it is recommended to use the client to import data sources.

Advanced Settings (Optional)​

You can choose the target directory, API unique identifier, and data model to be imported in the advanced settings.

Quick Import on the Main API​

After version 2.2.27, it is possible to quickly import data on the main API (project list page). You can choose to import to a new project or an existing project.