openapi4j

Project Url: openapi4j/openapi4j
Introduction: OpenAPI 3 parser, JSON schema and request validator.
More: Author   ReportBugs   OfficialWebsite   
Tags:

Build Status Maintainability Rating Security Rating Coverage

This repository is now archived. I don't have enough spare time to maintain this project (well actually revamp) and follow OAI specs. This project deserves much more that I can give to source code and followers to provide appropriate output.

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.

Documentation

The documentation for all modules is available here.

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>org.openapi4j</groupId>
    <artifactId>openapi-[module]</artifactId>
</dependency>

Release version Snapshot version

Snapshot is available for latest valid commit on 'master' branch.

Performance

Check here for some values.

Native compilation (GraalVM)

From version 0.7, the toolset is fully compliant with native compilation (AOT). This was tested with GraalVM 19.3.1. No further configuration or directive is needed to include the modules if available on classpath.

shell script native-image -H:+ReportExceptionStackTraces --no-fallback -jar your-app.jar

FYI, testing runs made don't show much performance improvements but parser module.

Supported versions

The modules currently support the OpenAPI Specification (OAS) version 3.0.x.

OAI 3.1.0 has been released as candidate.
There's too much changes too keep code on same basis and keep a fairly low level of complexity.
As a consequence, OAI 3.1.x support will be made in a version 2 of openapi4j.

As my time is very limited, version 1 should be considered as freezed for now.

See related projects for limitations and issues.

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

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

Apps
About Me
GitHub: Trinea
Facebook: Dev Tools