Stepping into the AsyncAPI

Dinuka Kasun Medis
1 min readJan 13, 2024

Recently, I had experience with Async APIs. It was an effective tool for defining event specifications. I decided to share some highlighted points with you.

Then let’s go 😎…..

  • Asyncapi studio is an option for generating your AsyncAPI file.
  • In addition, you have the option to incorporate plugins into your code editors. In my case I used VSCode Plugin and IntelliJ IDEs Plugin.
  • Asyncapi Studio allows you to create a visual representation of your events. It is a nice feature.
  • If you have previous experience with swagger, the this will be so easy for you.
  • Even if you have good documentation skills, some swagger formatting may not function properly in Async APIs. As an example, I faced some issues when formatting the ‘description’ and ‘summary’ tags. (I tried Version 2.4.0 and 3.0.0)

I am looking forward to writing more when I have more experience with this. Until that let’s follow the documentation with me 🤓.

--

--

Dinuka Kasun Medis

Hej, jag heter Dinuka Kasun. Välkommen till min profil. Arbeta som mjukvaruingenjör. Och nu för tiden lär jag mig svenska. 🤓🇱🇰 🇸🇪