javalin/javalin-openapiPublic

NotificationsYou must be signed in to change notification settings
Fork21
Star57

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

License

Apache-2.0 license

57 stars 21 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 333 Commits
.github		.github
.run		.run
examples		examples
gradle/wrapper		gradle/wrapper
javalin-plugins		javalin-plugins
openapi-annotation-processor		openapi-annotation-processor
openapi-specification		openapi-specification
wiki @ f7a1849		wiki @ f7a1849
.gitignore		.gitignore
.gitmodules		.gitmodules
LICENSE		LICENSE
build.gradle.kts		build.gradle.kts
gradle.properties		gradle.properties
gradlew		gradlew
gradlew.bat		gradlew.bat
settings.gradle.kts		settings.gradle.kts

Repository files navigation

OpenAPI Plugin

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

How to use

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 (throughKapt)
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

Universal modules

Module	Description
`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 plugins

Plugin	Description
`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