Giter VIP home page Giter VIP logo

javalin / javalin-openapi Goto Github PK

View Code? Open in Web Editor NEW
41.0 6.0 16.0 743 KB

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

Home Page: https://github.com/javalin/javalin-openapi/wiki

License: Apache License 2.0

Kotlin 98.70% Groovy 1.30%
javalin openapi javalin-openapi annotation-processor swagger-ui swagger openapi3 redoc javalin-plugin hacktoberfest json-schema

javalin-openapi's Introduction

OpenAPI Plugin CI Maven Central Version / Snapshot

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

Preview

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

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

Branches

Branch Javalin version OpenApi Version Java Version
main 6.x 6.x JDK11
5.x 5.x 5.x JDK11
4.x 4.x 1.x JDK8

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.