oas-gen-maven-plugin

This is a maven plugin which allows you to generate OpenApiSpecification v3 (Also known as Swagger) for JAX-RS resources during your build. It allows to generate multiples *.yaml files for different resource packages.

License

License

Categories

Categories

Maven Build Tools
GroupId

GroupId

ru.gladorange
ArtifactId

ArtifactId

oas-gen-maven-plugin
Last Version

Last Version

1.0
Release Date

Release Date

Type

Type

maven-plugin
Description

Description

oas-gen-maven-plugin
This is a maven plugin which allows you to generate OpenApiSpecification v3 (Also known as Swagger) for JAX-RS resources during your build. It allows to generate multiples *.yaml files for different resource packages.
Project URL

Project URL

https://github.com/gladorange/oas-jaxrs-generator
Source Code Management

Source Code Management

https://github.com/gladorange/oas-jaxrs-generator

Download oas-gen-maven-plugin

How to add to project

<plugin>
    <groupId>ru.gladorange</groupId>
    <artifactId>oas-gen-maven-plugin</artifactId>
    <version>1.0</version>
</plugin>

Dependencies

compile (4)

Group / Artifact Type Version
javax.ws.rs : javax.ws.rs-api jar 2.1
org.apache.maven : maven-plugin-api jar 3.0
io.swagger.core.v3 : swagger-jaxrs2 jar 2.0.0-rc4
org.apache.maven : maven-compat jar 3.0

provided (1)

Group / Artifact Type Version
org.apache.maven.plugin-tools : maven-plugin-annotations jar 3.0

Project Modules

There are no modules declared in this project.

oas-jaxrs-generator

This is a maven plugin which allows you to generate OpenApiSpecification v3 (Also known as Swagger) for JAX-RS resources during your build. It allows to generate multiples *.yaml files for different resource packages.

Example of usage:

Add plugin section to your build:

 <build>
        <plugins>
          <plugin>
            <groupId>ru.gladorange</groupId>
            <artifactId>oas-gen-maven-plugin</artifactId>
            <version>1.0</version>
            <configuration>
              <resources>
                <resource>
                  <packages>ups.auth</packages>
                  <filename>authentication.yaml</filename>
                </resource>
                <resource>
                  <packages>ups.discovery</packages>
                  <filename>discovery</filename>
                </resource>
                <resource>
                  <packages>ups.jc</packages>
                  <filename>join-meeting</filename>
                </resource>
                <resource>
                  <packages>ups.meetmgmt</packages>
                  <filename>meeting-management</filename>
                </resource>
              </resources>
            </configuration>
            <executions>
              <execution>
                <phase>process-classes</phase>
                <goals>
                  <goal>generate</goal>
                </goals>
              </execution>
            </executions>
          </plugin>
        </plugins>
      </build>

Versions

Version
1.0