Difficulty: Beginner
Estimated Time: 25 Minutes

The definition of each step of this tutorial can be found at https://github.com/devonfw-tutorials/tutorials/tree/main/openapi-generation-smallrye.

Feel free to report any errors to us or fix them yourself. Errors can be reported by creating an issue in the tutorials repository. To fix the error fork the repository and create a pull request. Errors in the wiki can be reported and fixed in the tutorial-compiler repository. You can find a description of what to look for when creating a pull request at the devonfw contribution guide: https://devonfw.com/website/pages/community/community.html#community.asciidoc_contributing-to-devonfw. If you want to create a tutorial you can start with the katacoda tutorial and read the description for creating your own tutorials: https://github.com/devonfw-tutorials/tutorials/wiki/Development.

This tutorial will show you how to include the Quarkus Smallrye OpenAPI extension in Quarkus projects to automatically generate OpenAPI specifications and Swagger UI from your REST APIs. For more information about OpenAPI and the Smallrye OpenAPI extension, see the devon4j documentation or the official Quarkus guide.



  • Installed devonfw-ide (or at least Java and Maven installed)


Learning goals

  • You will learn how to generate OpenAPI specifications and Swagger UI from REST services

OpenAPI and Swagger UI generation with Quarkus Smallrye extension

Step 1 of 4

Clone quarkus-quickstarts repository

First, clone the quarkus-quickstarts repository from GitHub. It contains several sample applications for many extensions to Quarkus. We will use a simple REST service for this tutorial and customize the application accordingly.

Please change the folder to 'devonfw/workspaces/main'.

cd devonfw/workspaces/main

Now clone the repository to your local directory.

git clone https://github.com/quarkusio/quarkus-quickstarts.git