Skip to content

Installation

This project supports two primary entry points:

  • CLI: openapi-testgen
  • Gradle plugin: art.galushko.openapi-test-generator

Requirements

  • Java 21 or later (required for both CLI and Gradle plugin)
  • Kotlin 2.2.x compatible
  • OpenAPI 3.0.x and 3.1.x specifications supported

CLI

Download from GitHub

Download the latest release from the GitHub Releases page:

  • JVM distribution (openapi-testgen-<version>.zip): Cross-platform, requires Java 21+
  • Native binary (openapi-testgen-<version>-<platform>): Standalone executable, no Java required
    • linux-amd64: Linux x86_64
    • macos-arm64: macOS Apple Silicon
    • windows-amd64: Windows x86_64

JVM distribution

# Download and extract
unzip openapi-testgen-0.8.0.zip
cd openapi-testgen-0.8.0

# Run
./bin/openapi-testgen --help

Native binary

# Download and make executable (Linux/macOS)
chmod +x openapi-testgen-0.8.0-linux-amd64
./openapi-testgen-0.8.0-linux-amd64 --help

# Or rename for convenience
mv openapi-testgen-0.8.0-linux-amd64 openapi-testgen
./openapi-testgen --help

Build from source

For development or custom builds:

# JVM distribution
./gradlew :cli:installDist
./cli/build/install/openapi-testgen/bin/openapi-testgen --help

# Native image (requires GraalVM)
./gradlew :cli:nativeCompile
./cli/build/native/nativeCompile/openapi-testgen --help

See the CLI reference for complete usage and options.

Gradle plugin

The plugin is published to the Gradle Plugin Portal.

Apply the plugin

Using the plugins DSL (recommended):

plugins {
    id("art.galushko.openapi-test-generator") version "0.8.0"
}

Or using legacy plugin application:

buildscript {
    repositories {
        gradlePluginPortal()
    }
    dependencies {
        classpath("art.galushko:openapi.testgen.plugin:0.8.0")
    }
}

apply(plugin = "art.galushko.openapi-test-generator")

Then configure openApiTestGenerator { ... }. See: Gradle integration and Gradle plugin reference.