A Kafka Developer’s Guide to AsyncAPI

How Kafka developers can use the AsyncAPI specification to describe how their applications are using Kafka topics.

In my post “Why should you document your Kafka topics?” last week, I wrote about the benefits of documenting your Kafka event sources, and mentioned a few of the problems that this can help with.

In this post, I want to show you how you can document the API for your Kafka event sources by creating AsyncAPI documents.

You don’t necessarily have to learn the AsyncAPI specification – tools such as the new Event Endpoint Management capability that I work on in Cloud Pak for Integration make it easy to document APIs with user-friendly forms that generate AsyncAPI documents for you. However, some developers will want to know more about what is happening under the covers, so here is an introduction.


For more info about getting started with Event Endpoint Management you can check the Cloud Pak for Integration Knowledge Center or join our webinar, “Automate your integration – What’s new in Cloud Pak for Integration 2021.1.1” on April 15th.

Tags: , ,

Comments are closed.