Helidon with Swagger / OpenAPI by Suren Konathala

image

Swagger UI is a great resource to generate and show docs for (java based) APIs. While adding a Swagger UI to a maven based project should be straight forward, adding a few annotations to your class and some dependencies to your pom.xml. It turned out there are a few steps involved for Helidon built projects. This article presents those details.

TL;DR

This article discusses the how-to’s of setting up Swagger UI to a project built with Helidon MP . A working example is on Github.

Why this post?

It took a while for me to setup Swagger UI to my API-only project built with Helidon MP. Wanted to share this article to my fellow developers, to save time.

Getting started

Building from scratch

If you already have an existing project, skip steps 1 and 2

1. Create a new project using Helidon MP’s archetype

mvn -U archetype:generate 
     -DinteractiveMode=false
     -DarchetypeGroupId=io.helidon.archetypes
     -DarchetypeArtifactId=helidon-quickstart-mp
     -DarchetypeVersion=2.3.4
     -DgroupId=io.helidon.examples
     -DartifactId=helidon-quickstart-mp
     -Dpackage=io.helidon.examples.quickstart.mp

2.Build and Run the default project Read the complete article here.

Developer Partner Community

For regular information become a member in the Developer Partner Community please register here.

clip_image003 Blog clip_image005 Twitter clip_image004 LinkedIn image[7][2][2][2] Facebook image Meetups

Technorati Tags: PaaS,Cloud,Middleware Update,WebLogic, WebLogic

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

This site uses Akismet to reduce spam. Learn how your comment data is processed.