v1.4.0

We are happy to announce the release of KumuluzEE OpenAPI MicroProfile 1.4.0. This version brings an integration of kumuluzee-openapi-mp-maven-plugin with OASFilterProvider SPI. Maven plugin has also been refactored in order to generate OAS files even faster.

Features:

• Refactored maven plugin for generating OpenAPI schema at compile-time.
• Added SPI ConfigurableOASFilter.

Enhancements:

• Upped SmallRye OpenAPI version.

v1.3.0

We are happy to announce the release of KumuluzEE OpenAPI MicroProfile 1.3.0. This version brings a new Maven plugin which generates OpenAPI schema at compile-time and a new SPI interface which can be used to extend the generated schema.

To use the new Maven plugin add it to pom.xml:

<plugin>
    <artifactId>kumuluzee-openapi-mp-maven-plugin</artifactId>
    <groupId>com.kumuluz.ee.openapi</groupId>
    <version>${kumuluzee-openapi-mp.version}</version>
    <executions>
        <execution>
            <goals>
                <goal>generate</goal>
            </goals>
        </execution>
    </executions>
</plugin>

On next build the schema will be available in target/generated/openapi.yaml and target/generated/openapi.json. For more information about the maven plugin, see README.

The new SPI interface allows extension developers to extend the generated schema. To use it implement the com.kumuluz.ee.openapi.mp.spi.OasFilterProvider interface and register it with a service file.

Features:

• Added a new maven plugin for generating OpenAPI schema at compile-time.

Enhancements:

• Added a new SPI interface OasFilterProvider for extending generated schema.

v1.2.2

This minor release enabled UTF-8 response encoding of OAS.

v1.2.1

We are announcing the release of KumuluzEE OpenAPI MicroProfile 1.2.1, which just fixes the failed deploy of the previous version 1.2.0 and features just some updated dependencies.

v1.2.0

We are announcing the release of v1.2.0 that brings feature for automatic configuration of redirect path and server.

Server auto-configuration allows for dynamic resolution of parameters like kumuluzee.openapi-mp.ui.specification-server
instead of need to set it. This is done by retrieving necessary information from request during runtime and based on that
setting correct redirect. It is especially useful when service is being deployed in multiple environments.
This feature also updates the list of servers in Swagger UI and reorder them, so it will be the first one.
It is also possible to resolve correct redirect when service is behind, for example, Ingres (Ingress must have enabled feature which
forwards the original URL).

Default settings for server auto-configuration:

kumuluzee:
  openapi-mp:
    ui:
      server-auto-config:
        enabled: false
        original-uri-check: false

See more in README.MD

v1.1.2

We are happy to announce the release of KumuluzEE OpenAPI MicroProfile 1.1.2. It implements the updated MicroProfile OpenAPI specification 1.1.2. It features the support for JAX-RS PATCH method and improves usability of various annotations. We have also optimized the scanning process which greatly reduces the startup time. Another addition is the inclusion of Swagger UI which can be served right from your microservice.

Startup time has been greatly reduced since we are no longer scanning the entire class-path but instead only the main archive. To scan additional archives you need to add them to the configuration. All archives containing JAX-RS resources and entities returned by them must be included. For example to add the models and rest artifacts, your configuration could look something like this:

kumuluzee:
  dev:
    scan-libraries:
      - models
      - rest

You can also disable scanning optimization and debug your scanning configuration by enabling the features in the configuration. For more information check out the README of the project.

This release also includes Swagger UI. To enable it simply add the following dependency:

<dependency>
    <groupId>com.kumuluz.ee.openapi</groupId>
    <artifactId>kumuluzee-openapi-mp-ui</artifactId>
    <version>${kumuluzee-openapi-mp.version}</version>
</dependency>

By default Swagger UI is accessible on /api-specs/ui, but you can remap it anywhere you want by setting the kumuluzee.openapi-mp.ui.mapping configuration value to the desired path.

v1.0.1

We are releasing the first version of KumuluzEE OpenAPI MicroProfile. It implements the MicroProfile OpenAPI specification 1.0.1. Initial version of KumuluzEE OpenAPI enables intuitive documentation of your REST resources using the MicroProfile OpenAPI annotations.

To start using the extension, simply add the following dependency to your application:

<dependency>
    <groupId>com.kumuluz.ee.openapi</groupId>
    <artifactId>kumuluzee-openapi-mp</artifactId>
    <version>${kumuluzee-openapi-mp.version}</version>
</dependency>

The sample showcasing some basic features is already available so go check it out! We will also update the sample to showcase some more advanced usages in the upcoming days.

We are excited to bring this extension into your hands!