tmarwen / micronaut-openapi

Generates OpenAPI / Swagger Documentation for Micronaut projects

Micronaut OpenAPI

This project allows generating OpenAPI 3.x (Swagger) specifications for a Micronaut application at compilation time. By moving the generation of OpenAPI specs into the compiler this project allows Micronaut applications to save on memory and avoid the need for costly computation at runtime unlike most implementations of OpenAPI which rely on processing to occur on the server.

Documentation

See the Documentation for more information.

See the Snapshot Documentation for the latest development version documentation.

Examples

You can generate example applications at https://launch.micronaut.io by selecting the Add Feature button and the openapi feature then generate!

Snapshots and Releases

Snaphots are automatically published to JFrog OSS using Github Actions.

See the documentation in the Micronaut Docs for how to configure your build to use snapshots.

Releases are published to JCenter and Maven Central via Github Actions.

A release is performed with the following steps:

• Edit the version specified by projectVersion in gradle.properties to a semantic, unreleased version. Example 1.0.0
• Create a new release. The Git Tag should start with v. For example v1.0.0.
• Monitor the Workflow to check it passed successfully.
• Celebrate!