Skip to content

OpenAPI specification linter Maven plugin, supporting pluggable rules via Zally. Requires no additional dependencies or services.

License

Notifications You must be signed in to change notification settings

ethlo/zally-maven-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Aug 28, 2021
0b9cd8a · Aug 28, 2021

History

13 Commits
Aug 28, 2021
Aug 27, 2021
Aug 27, 2021
Aug 27, 2021
Aug 27, 2021
Aug 28, 2021
Aug 28, 2021

Repository files navigation

Zally-maven-plugin

Maven Central Hex.pm Build Status Coverage Status

Unofficial maven plugin using Zally for OpenAPI 3.x specification validation.

Benefits

  • Simple to use and tweak rules to fit your requirements
  • No Zally installation/server setup required
  • Supports API definitions with external references out of the box

Usage

<plugin>
    <groupId>com.ethlo.zally</groupId>
    <artifactId>zally-maven-plugin</artifactId>
    <version>VERSION</version>
    <configuration>
        <!--Configure severities that fail the build. Default is MUST, SHOULD -->
        <failOn>MUST</failOn>
        <!-- The input file to validate -->
        <source>src/main/resources/openapi/api.yaml</source>
        <!--Ignore certain rules. Default is none -->
        <ignore>
            146,174,134
        </ignore>
        <!-- Write the result of the validation to file. Optional-->
        <resultFile>target/api_validation_result.yaml</resultFile>
    </configuration>
    <executions>
        <execution>
            <goals>
                <goal>validate</goal>
            </goals>
        </execution>
    </executions>
</plugin>

About

OpenAPI specification linter Maven plugin, supporting pluggable rules via Zally. Requires no additional dependencies or services.

Topics

Resources

License

Stars

Watchers

Forks

Languages