Git Connection

INFO

Please ensure that your Apidog version is ≥2.7.29.

Apidog supports automatically backing up the OpenAPI / Swagger files for each module in a project to a Git repository. GitHub, GitLab, and Azure DevOps are currently supported. Backups are performed during off-peak hours at night (the exact time is not fixed and is randomly scheduled during idle periods).

Creating a Git Repository Connection

Navigate to Settings → Git Connections

📷 Visual Reference

Click New, then log in to the corresponding source code management platform after being redirected.

Fill in the configuration details according to your selected platform.

📷 Visual Reference

Save the repository connection configuration.

Enabling Automatic Backup

In the module you want to back up, go to Overview → API Specification and add an OAS.

📷 Visual Reference

Enable Backup to Git Repository.

Configure the following settings:

Git Repository Connection (select a previously created connection)

Git Branch

Target File Path (the location where the OpenAPI Spec file will be stored in the repository)

📷 Visual Reference

Once saved, the system will automatically push the OpenAPI Spec file for that module to the specified Git repository during a random off-peak time at night.

📷 Visual Reference

Import OpenAPI/Swagger Files

You can import OpenAPI/Swagger files from remote repositories on a regular basis. In Settings → Bind Data Sources, select Git Repository as the data source and bind your remote repository. For detailed explanation, check the Scheduled Import page.

Creating a Git Repository Connection#

Enabling Automatic Backup#

Import OpenAPI/Swagger Files#

Creating a Git Repository Connection

Enabling Automatic Backup

Import OpenAPI/Swagger Files