openapi-spring-test-generator-webflux

Spring Webflux implementation of the OpenApi generator

License

License

Categories

Categories

Java Languages
GroupId

GroupId

eu.lundegaard.java
ArtifactId

ArtifactId

openapi-spring-test-generator-webflux
Last Version

Last Version

1.0.2
Release Date

Release Date

Type

Type

jar
Description

Description

openapi-spring-test-generator-webflux
Spring Webflux implementation of the OpenApi generator
Project Organization

Project Organization

Lundegaard a.s.

Download openapi-spring-test-generator-webflux

How to add to project

<!-- https://jarcasting.com/artifacts/eu.lundegaard.java/openapi-spring-test-generator-webflux/ -->
<dependency>
    <groupId>eu.lundegaard.java</groupId>
    <artifactId>openapi-spring-test-generator-webflux</artifactId>
    <version>1.0.2</version>
</dependency>
// https://jarcasting.com/artifacts/eu.lundegaard.java/openapi-spring-test-generator-webflux/
implementation 'eu.lundegaard.java:openapi-spring-test-generator-webflux:1.0.2'
// https://jarcasting.com/artifacts/eu.lundegaard.java/openapi-spring-test-generator-webflux/
implementation ("eu.lundegaard.java:openapi-spring-test-generator-webflux:1.0.2")
'eu.lundegaard.java:openapi-spring-test-generator-webflux:jar:1.0.2'
<dependency org="eu.lundegaard.java" name="openapi-spring-test-generator-webflux" rev="1.0.2">
  <artifact name="openapi-spring-test-generator-webflux" type="jar" />
</dependency>
@Grapes(
@Grab(group='eu.lundegaard.java', module='openapi-spring-test-generator-webflux', version='1.0.2')
)
libraryDependencies += "eu.lundegaard.java" % "openapi-spring-test-generator-webflux" % "1.0.2"
[eu.lundegaard.java/openapi-spring-test-generator-webflux "1.0.2"]

Dependencies

compile (4)

Group / Artifact Type Version
eu.lundegaard.java : openapi-spring-test-generator-common jar 1.0.2
org.springdoc : springdoc-openapi-webflux-core jar 1.1.47
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

There are no modules declared in this project.

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.

Maven Central

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
eu.lundegaard.java

Lundegaard a.s.

Versions

Version
1.0.2