CI/CD Integration

In the modern DevOps world, if it's not automated, it doesn't exist. You don't want to manually click "Run" every time a developer pushes code. You want your tests to run automatically, blocking bad code from reaching production.

Apidog integrates seamlessly with Jenkins, GitHub Actions, GitLab CI, and others via the Apidog CLI.

The Core: Apidog CLI

Apidog CLI is a command-line tool that allows you to run test scenarios exported from Apidog (or directly from the cloud) in any environment—Linux servers, Docker containers, or Jenkins agents.

See details: Apidog CLI

1. Install Apidog CLI

It's an npm package, so it runs anywhere Node.js runs.

Basic Usage

To run a test scenario, you just need its ID (found in the CI/CD tab of your Test content).

Integration with GitHub Actions

This is the most common setup for open-source and modern teams.

Step 1: Get your Token and ID

In Apidog, go to Test Scenario -> CI/CD.

Copy your APIDOG_ACCESS_TOKEN (keep this secret!).

Copy the executed command which contains the SCENARIO_ID.

Step 2: Create Workflow File

Create .github/workflows/api-test.yml in your repo:

Now, every time someone pushes code, GitHub allocates a server, installs Apidog CLI, runs your full regression suite, and reports pass/fail back to the Pull Request.

Integration with Jenkins / GitLab CI

The principle remains identical for other CI providers. Whether you are using Jenkins (via a sh 'npm install ...' step in your Groovy pipeline) or GitLab CI (adding a job in .gitlab-ci.yml), the core requirement is the same:
As long as the runner machine has internet access and can reach your API, the Apidog CLI will work.

Running with Localhost

A common challenge in CI is that the API isn't deployed yet—it's running on the CI machine's localhost.

Apidog CLI handles this naturally because it runs directly on the CI machine. You simply structure your pipeline to first start your API (e.g., npm start &), wait for the port to open, and then execute the Apidog CLI command against http://localhost:8000.

Key Takeaways

Integrate API tests into CI/CD pipelines

Use Apidog CLI for automation

Ensure continuous feedback loops

What's Next

CI/CD handles code changes. But what if the API goes down while no one is changing code? We need Monitoring.

In the next chapter, we'll set up Scheduled Tasks to watch your API 24/7.

Continue with → Scheduled Tasks and Automation

The Core: Apidog CLI#

1. Install Apidog CLI#

Basic Usage#

Integration with GitHub Actions#

Step 1: Get your Token and ID#

Step 2: Create Workflow File#

Integration with Jenkins / GitLab CI#

Running with Localhost#

Key Takeaways#

What's Next#