Git Connection

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 and GitLab are currently supported.

Feature Overview

Automatically back up the OpenAPI / Swagger file for each module in Apidog to a GitHub repository

Automatically back up the OpenAPI / Swagger file for each module in Apidog to a GitLab repository

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"

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

Fill in the configuration details:

GitHub: Name, Description, GitHub Organization, GitHub Repository

GitLab: Name, Description, GitLab Group, GitLab Project

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.

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)

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.

Feature Overview#

Creating a Git Repository Connection#

Enabling Automatic Backup#

Feature Overview

Creating a Git Repository Connection

Enabling Automatic Backup