notes, thoughts & info

less than 1 minute read

OpenAPI Specification is a good way to define and describe your API for anyone who is interested in using your apis. So, I found a couple of open source implementation options on the internet:

  1. Springfox tldr -> unmaintained
  2. Springdoc tldr -> good

After checking out springfox, it doesn’t work well with newer versions of spring boot, for example spring boot 3. Its github page has a lot of issues and the latest commit to master was 2020! Looks like its not maintained.

On the other hand, Springdoc had great documentation to start with SpringDoc and they support reactive and kotlin too.

It’s possible to have multiple api docs at once and provide a gradle task to generate your doc, albeit it’s quite quirky. Basically it boots up the app to query the configured endpoint doc and created the file for you.

Comments

You May Also Enjoy

Implementing prefix trie

3 minute read

Introduction: A prefix trie is a tree data structure that stores strings that is prefix searchable. The nodes of the tree are actually the elements of the a...

Implementing binary heap

4 minute read

Overview A binary heap is a complete binary tree that satisfies the heap property. There are two main ways to represent binary heaps: Array representati...

Introducing observability with prometheus

2 minute read

Using open source observability tools like prometheus, it is convenient to track and understand how your application performs, especially if cloud providers ...