Skip to content

Generate your first test suite (CLI)

This tutorial generates tests from an OpenAPI spec using the CLI.

1) Get the CLI

Download from GitHub Releases or build from source:

# Option A: Download native binary (no Java required)
curl -LO https://github.com/GalushkoArt/openapi-testgen-monorepo/releases/latest/download/openapi-testgen-linux-amd64
chmod +x openapi-testgen-linux-amd64
mv openapi-testgen-linux-amd64 openapi-testgen

# Option B: Build from source
./gradlew :cli:installDist
alias openapi-testgen='./cli/build/install/openapi-testgen/bin/openapi-testgen'

Verify installation:

openapi-testgen --help

2) Generate template-based tests

openapi-testgen \
  --spec-file path/to/openapi.yaml \
  --output-dir ./build/generated-tests \
  --generator template \
  --generator-option templateSet=restassured-java \
  --generator-option templateVariables.package=com.example.generated \
  --generator-option templateVariables.baseUrl=http://localhost:8080

This generates Java test classes using RestAssured that you can run with JUnit.

3) Generate JSON/YAML test suites

For data-driven testing or custom frameworks:

openapi-testgen \
  --spec-file path/to/openapi.yaml \
  --output-dir ./build/out \
  --generator test-suite-writer \
  --generator-option outputFileName=openapi-test-suites.json

This generates a JSON file containing test case definitions that can be consumed by any test runner.

Next steps