Skip to content

erosb/kappa

 
 

Repository files navigation

Kappa - OpenAPI validator for Java and JVM projects

This project is a successor of the archived openapi4j project.

This is the home page of the openapi4j project for Java (Jakarta or JVM platform in general).

openapi4j is a suite of tools, including the following :

  • Open API specification parser and validator.
  • Open API Schema Object validator.
  • JSON reference implementation.
  • Request/response validator against operation.
  • For internal use only, performance project reports some numbers to 'manually' check any improvements or regressions between versions.

Modules

  • Parser allows the (de-)serialization and manipulation of the schema and its validation.
  • Schema validator allows the validation of data against a given schema.
  • Request validator is high level module to manage validation for requests and/or responses against operations. More details in the related project.
  • Request adapters is the repository of specific adapters to wrap requests and responses.

Versioning and compatibility

All modules follow the Semantic Versioning 2.0.0 and are aligned on each release even there's no changes.

<dependency>
    <groupId>com.github.erosb</groupId>
    <artifactId>openapi-[module]</artifactId>
</dependency>

Supported versions

Kappa targets supporting OpenAPI 3.1. Currently it uses a draft2020-12 compliant validator for JSON Schema.

Contributing

Reporting issues, making comments, ... Any help is welcome !

We accept Pull Requests via GitHub. There are some guidelines which will make applying PRs easier for us :

  • Respect the code style and indentation. .editorconfig file is provided to not be worried about this.
  • Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change.
  • Provide JUnit tests for your changes and make sure your changes don't break anything by running gradlew clean check.
  • Provide a self explanatory but brief commit message with issue reference if any, as it will be reported directly for release changelog.

License

Kappa and all the modules are released under the Apache 2.0 license. See LICENSE for details.

Contributor notes

Release to local maven repo: ./gradlew build publishToMavenLocal Release to maven central: ./gradlew build publishToSonatype closeAndReleaseSonatypeStagingRepository

About

OpenAPI 3.1 validator library for Java and JVM

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 7

Languages