Cloud Pak for Integration

Other ways to use AsyncAPI documents

By Dale Lane posted 20 days ago


In our post last week, we shared a demo of the Event Endpoint Management experience.

We mentioned that the descriptions of Kafka topics are stored as AsyncAPI documents. And we've described a bit about the AsyncAPI specification.

One thing you may have noticed is that developers using the Developer Portal can download the AsyncAPI document. This is because there is a growing ecosystems of tools that support the AsyncAPI standard.

In this post, we wanted to share a few demos of what a developer can do with the AsyncAPI documents they download from the Developer Portal.

Generating mock events

AsyncAPI documents can be used in mocking tools like the open source Microcks, to generate a stream of mock Kafka events based on the description in an AsyncAPI document.

This means that you can start developing your Kafka application against a private, mock Kafka topic and a stream of Kafka events generated from the specification in the AsyncAPI doc. This might be useful if you want to develop your application in private before you start using the real production Kafka cluster.


AsyncAPI documents can be used in prototyping tools like the open source Node-RED, to allow you to prototype how you want to process the events on a Kafka topic you discover in the Developer Portal.

Code generation

Developer Portal generates sample code to help developers get started with updating their application to consume events from a Kafka topic that they discover through Event Endpoint Management.

There are also other ways to generate code from an AsyncAPI document. The AsyncAPI organisation on GitHub contains code generators that can create skeleton applications in a variety of programming languages.

#eventendpointmanagement #AsyncAPI