Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/micronaut-projects/micronaut-openapi

Generates OpenAPI / Swagger Documentation for Micronaut projects
https://github.com/micronaut-projects/micronaut-openapi

micronaut openapi rest-api swagger

Last synced: 7 days ago
JSON representation

Generates OpenAPI / Swagger Documentation for Micronaut projects

Host: GitHub
URL: https://github.com/micronaut-projects/micronaut-openapi
Owner: micronaut-projects
License: apache-2.0
Created: 2019-03-28T13:07:55.000Z (over 5 years ago)
Default Branch: 6.13.x
Last Pushed: 2024-10-29T08:49:45.000Z (15 days ago)
Last Synced: 2024-10-29T10:00:40.965Z (15 days ago)
Topics: micronaut, openapi, rest-api, swagger
Language: Java
Homepage: https://micronaut-projects.github.io/micronaut-openapi/latest/guide/index.html
Size: 69.4 MB
Stars: 80
Watchers: 19
Forks: 94
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md

Awesome Lists containing this project

README

        # Micronaut OpenAPI #

[![Maven Central](https://img.shields.io/maven-central/v/io.micronaut.openapi/micronaut-openapi.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22io.micronaut.openapi%22%20AND%20a:%22micronaut-openapi%22)

[![Build Status](https://github.com/micronaut-projects/micronaut-openapi/workflows/Java%20CI/badge.svg)](https://github.com/micronaut-projects/micronaut-openapi/actions)

[![Revved up by Develocity](https://img.shields.io/badge/Revved%20up%20by-Develocity-06A0CE?logo=Gradle&labelColor=02303A)](https://ge.micronaut.io/scans)

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](https://micronaut-projects.github.io/micronaut-openapi/latest/guide/index.html) for more information.

See the [Snapshot Documentation](https://micronaut-projects.github.io/micronaut-openapi/snapshot/guide/index.html) 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

Snapshots are automatically published to [Sonatype Snapshots](https://s01.oss.sonatype.org/content/repositories/snapshots/io/micronaut/) using [GitHub Actions](https://github.com/micronaut-projects/micronaut-openapi/actions).

See the documentation in the [Micronaut Docs](https://docs.micronaut.io/latest/guide/index.html#usingsnapshots) for how to configure your build to use snapshots.

Releases are published to Maven Central via [GitHub Actions](https://github.com/micronaut-projects/micronaut-openapi/actions).

A release is performed with the following steps:

* [Publish the draft release](https://github.com/micronaut-projects/micronaut-openapi/releases). There should be already a draft release created, edit and publish it. The Git Tag should start with `v`. For example `v1.0.0`.

* [Monitor the Workflow](https://github.com/micronaut-projects/micronaut-openapi/actions?query=workflow%3ARelease) to check it passed successfully.

* Celebrate!