Find your community
Join us for IBM TechXchange Day: AI and Automation
We’re excited to see today’s release of version 3 of the AsyncAPI standard. We’ve talked about AsyncAPI here before , and it has been an important part of IBM’s Event Endpoint Management for years. AsyncAPI is an open standard for documenting and describing your asynchronous APIs, such as your queues and topics in message brokers and queue managers. Having a standard way to document these critical aspects of your architectures brings benefits in discoverability, as well as enabling a growing ecosystem of tools and utilities. Today, AsyncAPI has taken a big step forward with version 3.0.0
As part of AsyncAPI Conference this week, I ran a session on how to describe Kafka security in AsyncAPI. The aim of the session was to quickly show how to describe the security configuration of a Kafka cluster in an AsyncAPI document. And, in reverse, if you’ve been given an AsyncAPI document, to show how to use that to configure a Kafka client or application to connect to the cluster, using the details in the AsyncAPI spec
See matching posts in thread - Does AppConnect Enterprise support async...
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
What does the following AsyncAPI document describe?...Like with OpenAPI, an AsyncAPI documents an application from the "client" perspective
How Kafka developers can use the AsyncAPI specification to describe how their applications are using Kafka topics
AsyncAPI version 3 was released in December 2023 . In this post, I want to highlight some of the adoption of this new version of the specification, by sharing some of the things that you can do with AsyncAPI v3 documents. I'll demonstrate this with: Event Endpoint Management Download AsyncAPI documents for Kafka topics shared for reuse AsyncAPI v3 support added in version 11.1.1 (Dec 2023) AsyncAPI java-template Generate complete Java projects from AsyncAPI documents AsyncAPI v3 support added in version 0.3.0 (Mar 2024) Microcks Generate Kafka topics with mock data from AsyncAPI documents AsyncAPI v3 support added in version 1.9.0 (Mar 2024) Event Endpoint Management When you have Kafka topics that you want to enable teams to reuse, Event Endpoint Management lets you treat them as asynchronous APIs that can be published and managed
To support a standard way of describing and man a ging event sources, Event Endpoint Management uses the AsyncAPI specification, the industry standard for defining asynchronous APIs
For example, we've discussed the benefits to your organisation of documenting and socializing your Kafka topics , we've described the AsyncAPI specification we're using to document Events, and we've talked about where Event Endpoint Management fits into the broader API Management picture
They think this stream of events might be useful to other developers in their organisation, so they describe it (using AsyncAPI ) and publish this to a catalog where it can be discovered and managed