Skip to main content

Migrating from Springfox to OpenAPI 3 in spring boot Java

Migrating from Springfox to OpenAPI 3 in Spring Boot Application

This blogpost, I would like to share about the migration to OpenAPI 3 in my project application that is built using Java 8 and Spring boot. 

I was working in a project that had a very old framework support and JDK. I was taking my free time whenever I find one and then did some upgrade to the core so as to get the application to be on the latest frameworks and get support if any issues.

Why Upgrade?

The reason for upgrade is to facilitate the following

  1. The application dependencies are up-to-date, meaning that when we face any issue or require any help, people will be able to help (Community support). Though we have support for the deprecated frameworks also from the vibrant community like Stackoverflow.com, better to be with the upgrades
  2. There might be limitations hindering in building new functionality or extending existing ones with the older versions, so a version upgrade to the latest will be always handy
  3. There is a learning curve and a good boost for the developers so that they dont get fed up like we still have to stick our hands in the old versions and could not learn anything new
  4. Lots of performance, security patches and modernisation support can be leveraged

Steps to Migrate

  • Remove springfox and swagger 2 dependencies. Add springdoc-openapi-ui dependency instead

springdoc-openapi-ui
springdoc-openapi-data-rest -> This is mandatory for exposing REST API

  • Replacing the Springfox annotations to suit the latest springdoc annotations. I do not want to copy paste from springdoc, because there might be new updates which might get lost in this blog post, so the link is here.
  • In the Application.java, where you have the application run method, use the below code snippet with the values suitable for your project descriptions
@Bean
   public OpenAPI springShopOpenAPI() {
       return new OpenAPI()
               .info(new Info().title("SpringShop API")
               .description("Spring shop sample application")
               .version("v0.0.1")
               .license(new License().name("Apache 2.0").url("http://springdoc.org")))
               .externalDocs(new ExternalDocumentation()
               .description("SpringShop Wiki Documentation")
               .url("https://springshop.wiki.github.org/docs"));
   }

5. Once this is done, your application is ready to be used with the latest version of springdoc

Now that the URL's are changed, you will have to navigate to below like URL

http[s]://host:port/<appName>/swagger-ui.html

Difficult parts

The main difficulty is when we migrate from the current version of spring fox / swagger-ui 2 to the above mentioned springdoc.

I had to literally update all my APIControllers with the annotation tag changes, with replace in all files helped

Additionally, the response and the responseContainer properties are no longer present, so they will have to be removed for sure.

The above steps took me approx 4-5 hrs as there was a lot of places to change and finally able to get the new UI up and running.

Posting here in case it might be of help for someone.

Labels:

Comments

Post a Comment

Popular posts from this blog

User Authentication schemes in a Multi-Tenant SaaS Application

User Authentication in Multi-Tenant SaaS Apps Introduction We will cover few scenarios that we can follow to perform the user authentication in a Multi-Tenant SaaS application. Scenario 1 - Global Users Authentication with Tenancy and Tenant forwarding In this scheme, we have the SaaS Provider Authentication gateway that takes care of Authentication of the users by performing the following steps Tenant Identification User Authentication User Authorization Forwarding the user to the tenant application / tenant pages in the SaaS App This demands that the SaaS provider authentication gateway be a scalable microservice that can take care of the load across all tenants. The database partitioning (horizontal or other means) is left upto the SaaS provider Service. Scenario 2 - Global Tenant Identification and User Authentication forwarding   In the above scenario, the tenant identification happens on part of the SaaS provider Tenant Identification gateway. Post which, the
Post a Comment
Read more

Handling exceptions in the Executor service threads in Java

Introduction This is a continuation post on the exception handling strategies in the threads in Java. For Introduction, please read this post The second post is available here This post addresses the problem statement "How to use the exception handlers in the threads spawned by the Executor Service in Java?" Not all times, we will be using Thread  classes to run our threads because we have to manage a lot of the underlying logic for managing threads. There is ExecutorService in Java which comes to the rescue for the above problem. In the previous posts, we have discussed on how to handle the exceptions in plain threads. However, when using executor service, we do not create / manage threads, so how do we handle exception in this case. We have a ThreadFactory   as an argument which can be used to customize the way threads are created for use within the ExecutorService . The below snippet of code leverages this feature to illustrate the exception handling, wherein we create a
Post a Comment
Read more

Download CSV file using JavaScript fetch API

Downloading a CSV File from an API Using JavaScript Fetch API: A Step-by-Step Guide Introduction: Downloading files from an API is a common task in web development. This article walks you through the process of downloading a CSV file from an API using the Fetch API in JavaScript. We'll cover the basics of making API requests and handling file downloads, complete with a sample code snippet. Prerequisites: Ensure you have a basic understanding of JavaScript and web APIs. No additional libraries are required for this tutorial. Step 1: Creating the HTML Structure: Start by creating a simple HTML structure that includes a button to initiate the file download. <!DOCTYPE html> < html lang = "en" > < head > < meta charset = "UTF-8" > < meta name = "viewport" content = "width=device-width, initial-scale=1.0" > < title > CSV File Download </ title > </ head > < body >
Post a Comment
Read more

SFTP and File Upload in SFTP using C# and Tamir. SShSharp

The right choice of SFTP Server for Windows OS Follow the following steps, 1. Download the server version from here . The application is here 2. Provide the Username, password and root path, i.e. the ftp destination. 3. The screen shot is given below for reference. 4. Now download the CoreFTP client from this link 5. The client settings will be as in this screen shot: 6. Now the code to upload files via SFTP will be as follows. //ip of the local machine and the username and password along with the file to be uploaded via SFTP. FileUploadUsingSftp("172.24.120.87", "ftpserveruser", "123456", @"D:\", @"Web.config"); private static void FileUploadUsingSftp(string FtpAddress, string FtpUserName, string FtpPassword, string FilePath, string FileName) { Sftp sftp = null; try { // Create instance for Sftp to upload given files using given credentials sf
2 comments
Read more

Async implementation in Blazor

Step-by-Step Guide to Achieving Async Flows in Blazor: 1. Understanding Asynchronous Programming: Before delving into Blazor-specific async flows, it's crucial to understand asynchronous programming concepts like async and await . Asynchronous operations help improve the responsiveness of your UI by not blocking the main thread. 2. Blazor Component Lifecycle: Blazor components have their lifecycle methods. The OnInitializedAsync , OnParametersSetAsync , and OnAfterRenderAsync methods allow you to implement asynchronous operations during various stages of a component's lifecycle. 3. Asynchronous API Calls: Performing asynchronous API calls is a common scenario in web applications. You can use HttpClient to make HTTP requests asynchronously. For example, fetching data from a remote server: @page "/fetchdata" @inject HttpClient Http @ if (forecasts == null ) { <p> < em > Loading... </ em > </ p > } else { <table>
Post a Comment
Read more