Skip to main content

OpenAPI Maven Plugin

Easily turn your Java APIs into OpenAPI documentation.

Hybrid Analysis Approach

Uses both compiled classes and source code to enrich the generated specification: extracts Javadoc comments directly, without extra annotations.

Highly configurable

Numerous options to fine-tune the generated documentation: whitelists / blacklists, multiple documentation generation, default errors, ...

Fast and flexible

Works faster than methods requiring a running application or integration test execution. Documentation can be generated from modules that only contain interfaces.

Lightweight & Secure

No extra dependencies added to your JAR/WAR. Reduces the surface for security vulnerabilities compared to other methods.

Broad compatibility

Works with Spring MVC, Jakarta REST and JAX-RS. Verified with JDK 8, 11, 17, and 21.

Open source & free

Missing a feature? Add it to the project! 😉