Enable OpenAPI and Swagger UI in Helidon MP application

Hi Team,

Today I'm sharing my learning to how to configure OpenAPI and Swagger UI in a Helidon MP application.

Helidon is closely associated with OpenAPI, hence we only need configurations to enable Open API.

dependencies


        <dependency>
            <groupId>io.helidon.microprofile.openapi</groupId>
            <artifactId>helidon-microprofile-openapi</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.eclipse.microprofile.openapi</groupId>
            <artifactId>microprofile-openapi-api</artifactId>
        </dependency>
        <dependency>
            <groupId>io.helidon.integrations.openapi-ui</groupId>
            <artifactId>helidon-integrations-openapi-ui</artifactId>
            <scope>runtime</scope>
        </dependency>

plugins

            <plugin>
                <groupId>org.jboss.jandex</groupId>
                <artifactId>jandex-maven-plugin</artifactId>
                <version>1.1.0</version>
                <executions>
                    <execution>
                        <id>make-index</id>
                        <goals>
                            <goal>jandex</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>

References :
https://helidon.io/docs/v2/#/mp/openapi/01_openapi
https://helidon.io/docs/latest/index.html#/mp/openapi/openapi-ui

Comments

Popular posts from this blog

Tracing Oracle Helidon Application with Zipkin

Profiling in Oracle Helidon