openapi-spring-test-generator

Parent POM of the OpenApi generator

License	The Apache Software License, Version 2.0
Categories	Java Languages
GroupId	eu.lundegaard.java
ArtifactId	openapi-spring-test-generator
Last Version	1.0.2
Release Date	Nov 11, 2019
Type	pom
Description	openapi-spring-test-generator Parent POM of the OpenApi generator
Project URL	https://github.com/lundegaard/openapi-spring-test-generator
Project Organization	Lundegaard a.s.
Source Code Management	https://github.com/lundegaard/openapi-spring-test-generator.git

Download openapi-spring-test-generator

Filename	Size
openapi-spring-test-generator-1.0.2.pom	8 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/eu.lundegaard.java/openapi-spring-test-generator/ -->
<dependency>
    <groupId>eu.lundegaard.java</groupId>
    <artifactId>openapi-spring-test-generator</artifactId>
    <version>1.0.2</version>
    <type>pom</type>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/eu.lundegaard.java/openapi-spring-test-generator/
implementation 'eu.lundegaard.java:openapi-spring-test-generator:1.0.2'

Gradle Kotlin

// https://jarcasting.com/artifacts/eu.lundegaard.java/openapi-spring-test-generator/
implementation ("eu.lundegaard.java:openapi-spring-test-generator:1.0.2")

Apache Buildr

'eu.lundegaard.java:openapi-spring-test-generator:pom:1.0.2'

Apache Ivy

<dependency org="eu.lundegaard.java" name="openapi-spring-test-generator" rev="1.0.2">
  <artifact name="openapi-spring-test-generator" type="pom" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='eu.lundegaard.java', module='openapi-spring-test-generator', version='1.0.2')
)

Scala SBT

libraryDependencies += "eu.lundegaard.java" % "openapi-spring-test-generator" % "1.0.2"

Leiningen

[eu.lundegaard.java/openapi-spring-test-generator "1.0.2"]

Dependencies

compile (2)

Group / Artifact	Type	Version
org.springframework.boot : spring-boot-starter	jar
org.springframework.boot : spring-boot-configuration-processor Optional	jar

provided (1)

Group / Artifact	Type	Version
org.projectlombok : lombok	jar

test (2)

Group / Artifact	Type	Version
org.springframework.boot : spring-boot-starter-test	jar
org.junit.jupiter : junit-jupiter	jar	5.5.2

Project Modules

• openapi-spring-test-generator-common
• openapi-spring-test-generator-mvc
• openapi-spring-test-generator-webflux

openapi-spring-test-generator

A Spring Boot starter that generates OpenAPI documentation during the test phase of the project.

This library wraps springdoc-openapi library that produces OpenAPI endpoint in running Spring applications.

POM Configuration

Add following dependency with test scope to activate this library. For webflux applications, use openapi-spring-test-generator-weblux artifact.

<project>
  ...
  <dependencies>
    ...
    <dependency>
        <groupId>eu.lundegaard.java</groupId>
        <artifactId>openapi-spring-test-generator-mvc</artifactId>
        <version>${latest-version}</version>
        <scope>test</scope>
    </dependency>
    ...
  </dependencies>
   ...
</project>

Configuration

You can configure output by passing arguments via the surefire plugin.

<project>
    ...
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <configuration>
                    <systemPropertyVariables>
                        <openpi-generator.generateJson>false</openpi-generator.generateJson>
                        <openpi-generator.generateYaml>true</openpi-generator.generateYaml>
                        <openpi-generator.outputDirectory>target/generated-docs</openpi-generator.outputDirectory>
                    </systemPropertyVariables>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

Name	Default Value	Description
openpi-generator.generateJson	true	If true openapi.json will be generated into the output folder
openpi-generator.generateYaml	true	If true openapi.yaml will be generated into the output folder
openpi-generator.outputDirectory	target/classes/static/docs	Output folder

Lundegaard a.s.

Versions

Version
1.0.2 Nov 11, 2019