{"id":28465508,"url":"https://github.com/javalin/javalin-openapi","last_synced_at":"2026-02-23T02:40:01.213Z","repository":{"id":38746661,"uuid":"364314288","full_name":"javalin/javalin-openapi","owner":"javalin","description":"Annotation processor for compile-time OpenAPI \u0026 JsonSchema, with out-of-the-box support for Javalin 5.x, Swagger \u0026 ReDoc","archived":false,"fork":false,"pushed_at":"2025-06-22T22:08:45.000Z","size":766,"stargazers_count":54,"open_issues_count":10,"forks_count":20,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-06-22T23:19:22.303Z","etag":null,"topics":["annotation-processor","hacktoberfest","javalin","javalin-openapi","javalin-plugin","json-schema","openapi","openapi3","redoc","swagger","swagger-ui"],"latest_commit_sha":null,"homepage":"https://github.com/javalin/javalin-openapi/wiki","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/javalin.png","metadata":{"files":{"readme":".github/README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"dzikoysk"}},"created_at":"2021-05-04T16:10:52.000Z","updated_at":"2025-06-22T22:08:49.000Z","dependencies_parsed_at":"2023-02-15T09:46:33.363Z","dependency_job_id":"da1b21bb-83e6-47c7-8696-b66620f52a1e","html_url":"https://github.com/javalin/javalin-openapi","commit_stats":null,"previous_names":[],"tags_count":35,"template":false,"template_full_name":null,"purl":"pkg:github/javalin/javalin-openapi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/javalin%2Fjavalin-openapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/javalin%2Fjavalin-openapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/javalin%2Fjavalin-openapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/javalin%2Fjavalin-openapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/javalin","download_url":"https://codeload.github.com/javalin/javalin-openapi/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/javalin%2Fjavalin-openapi/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262614524,"owners_count":23337287,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["annotation-processor","hacktoberfest","javalin","javalin-openapi","javalin-plugin","json-schema","openapi","openapi3","redoc","swagger","swagger-ui"],"created_at":"2025-06-07T05:39:30.836Z","updated_at":"2026-02-23T02:40:01.205Z","avatar_url":"https://github.com/javalin.png","language":"Kotlin","funding_links":["https://github.com/sponsors/dzikoysk"],"categories":[],"sub_categories":[],"readme":"# OpenAPI Plugin [![CI](https://github.com/javalin/javalin-openapi/actions/workflows/gradle.yml/badge.svg)](https://github.com/javalin/javalin-openapi/actions/workflows/gradle.yml) ![Maven Central](https://img.shields.io/maven-central/v/io.javalin.community.openapi/openapi-annotation-processor?label=Maven%20Central) [![Version / Snapshot](https://maven.reposilite.com/api/badge/latest/snapshots/io/javalin/community/openapi/javalin-openapi-plugin?color=A97BFF\u0026name=Snapshot)](https://maven.reposilite.com/#/snapshots/io/javalin/community/openapi)\nCompile-time OpenAPI integration for Javalin 7.x ecosystem.\nThis is a new plugin that replaces [old built-in OpenApi module](https://github.com/javalin/javalin/tree/javalin-4x/javalin-openapi), \nthe API looks quite the same despite some minor changes.\n\n![Preview](https://user-images.githubusercontent.com/4235722/122982162-d2344f80-d39a-11eb-9a93-e52b9b7b7b53.png)\n\n### How to use\n\nSee https://javalin.github.io/javalin-openapi.\n\n### Notes\n* Reflection free\n* Uses `@OpenApi` to simplify migration from bundled OpenApi implementation\n* Supports Java 17+ and Kotlin (through [Kapt](https://kotlinlang.org/docs/kapt.html))\n* Uses internal WebJar handler that works with `/*` route out of the box\n* Provides better projection of OpenAPI specification\n* Schema validation through Swagger core module\n\n### Other examples\n* [Test module](https://github.com/javalin/javalin-openapi/blob/main/examples/javalin-gradle-kotlin/src/main/java/io/javalin/openapi/plugin/test/JavalinTest.java) - `JavalinTest` shows how this plugin work in Java codebase using various features\n* [Reposilite](https://github.com/dzikoysk/reposilite) - real world app using Javalin and OpenApi integration\n\n### Repository structure\n\n#### Universal modules\n\n| Module                         | Description                                                                                |\n|:-------------------------------|:-------------------------------------------------------------------------------------------|\n| `openapi-annotation-processor` | Compile-time annotation processor, should generate `/openapi-plugin/openapi-{default/\u003cversion\u003e}.json` resources |\n| `openapi-generator`            | Shared schema generation logic: type mappings, runtime builder DSL, example generation     |\n| `openapi-specification`        | Annotations \u0026 classes used to describe OpenAPI specification                               |\n| `examples`                 | Example Javalin application that uses OpenApi plugin in Gradle \u0026 Maven                     |\n\n#### Javalin plugins\n\n| Plugin                   | Description                                                                    |\n|:-------------------------|:-------------------------------------------------------------------------------|\n| `javalin-openapi-plugin` | Loads `/openapi-plugin/openapi-{default/\u003cversion\u003e}.json` resources and serves main OpenApi endpoint |\n| `javalin-swagger-plugin` | Serves Swagger UI                                                              |\n| `javalin-redoc-plugin`   | Serves ReDoc UI                                                                |\n\n#### Branches\n\n| Branch                                                       | Javalin version | OpenApi Version | Java Version |\n|:-------------------------------------------------------------|:----------------|:----------------|:-------------|\n| [main](https://github.com/javalin/javalin-openapi/tree/main) | 7.x             | 7.x             | JDK17        |\n| [6.x](https://github.com/javalin/javalin-openapi/tree/6.x)   | 6.x             | 6.x             | JDK11        |\n| [5.x](https://github.com/javalin/javalin-openapi/tree/5.x)   | 5.x             | 5.x             | JDK11        |\n| [4.x](https://github.com/javalin/javalin-openapi/tree/4.x)   | 4.x             | 1.x             | JDK8         |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjavalin%2Fjavalin-openapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjavalin%2Fjavalin-openapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjavalin%2Fjavalin-openapi/lists"}