herojeda / javalin-openapi

Annotation processor for compile-time OpenAPI & JsonSchema, with out-of-the-box support for Javalin 5.x, Swagger & ReDoc

OpenAPI Plugin

Compile-time OpenAPI integration for Javalin 5.x ecosystem. This is a new plugin that replaces old built-in OpenApi module, the API looks quite the same despite some minor changes.

How to use

• Wiki / Installation
• Wiki / Setup
• Wiki / Features

Notes

• Reflection free, does not perform any extra operations at runtime
• Uses @OpenApi to simplify migration from bundled OpenApi implementation
• Supports Java 11+ (also 16 and any further releases) and Kotlin (through Kapt)
• Uses internal WebJar handler that works with /* route out of the box
• Provides better projection of OpenAPI specification
• Schema validation through Swagger core module

Other examples

• Test module - JavalinTest shows how this plugin work in Java codebase using various features
• Reposilite - real world app using Javalin and OpenApi integration

Repository structure

• openapi-annotation-processor - compile-time annotation processor, should generate /openapi-plugin/openapi.json resource
• openapi-specification - annotations & classes used to describe OpenAPI specification
• openapi-test - example Javalin application that uses OpenApi plugin in Gradle & Maven

Javalin:

• javalin-openapi-plugin - loads /openapi-plugin/openapi.json resource and serves main OpenApi endpoint
• javalin-swagger-plugin - serves Swagger UI
• javalin-redoc-plugin - serves ReDoc UI