openapi-docgen-maven-plugin Maven Plugin

Maven plugin to generate OpenAPI documentation.

License	MIT License
Categories	Maven Build Tools
GroupId	com.markstickel.openapi
ArtifactId	openapi-docgen-maven-plugin
Last Version	1.0
Release Date	Jul 30, 2019
Type	maven-plugin
Description	openapi-docgen-maven-plugin Maven Plugin Maven plugin to generate OpenAPI documentation.

Download openapi-docgen-maven-plugin

Filename	Size
openapi-docgen-maven-plugin-1.0.pom
openapi-docgen-maven-plugin-1.0.jar	4 KB
openapi-docgen-maven-plugin-1.0-sources.jar	2 KB
openapi-docgen-maven-plugin-1.0-javadoc.jar	23 KB

How to add to project

Apache Maven

<plugin>
    <groupId>com.markstickel.openapi</groupId>
    <artifactId>openapi-docgen-maven-plugin</artifactId>
    <version>1.0</version>
</plugin>

Dependencies

compile (2)

Group / Artifact	Type	Version
com.markstickel.openapi : openapi-docgen-core	jar	1.0
org.apache.maven : maven-plugin-api	jar	2.0

provided (1)

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

Project Modules

There are no modules declared in this project.

openapi-docgen

Generates standalone html documentation from openapi yaml.

Prerequisites

You must have node installed.

Modules

This project contains two modules:

1. The core library, which wraps Node's redoc-cli library (and installs it if it is not present on your system)
2. A openapi-docgen-maven-plugin module. This is a Maven plugin that you can use as part of your build process to generate the documentation during the Maven lifecycle.

Using the openapi-docgen Maven plugin

    <build>
        <plugins>
            <plugin>
                <groupId>com.markstickel.openapi</groupId>
                <artifactId>openapi-docgen-maven-plugin</artifactId>
                <version>1.0</version>
                <executions>
                    <execution>
                        <id>generate-openapi-doc</id>
                        <phase>generate-resources</phase>
                        <inherited>false</inherited>
                        <configuration>
                            <input>petstore.yml</input>
                            <output>target/petstore-api.html</output>
                        </configuration>
                        <goals>
                            <goal>docgen</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

This configuration triggers the plugin during Maven's generate-resources phase.

Arguments

• input: the filename of a yaml- or json-formatted OpenAPI document to read in
• output: the filename to write the generated HTML to.

Versions

Version
1.0 Jul 30, 2019