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
We mentioned that the descriptions of Kafka topics are stored as AsyncAPI documents. And we've described a bit about the AsyncAPI specification
What about AsyncAPI?...What does the following AsyncAPI document describe?...An AsyncAPI document can have multiple purposes
How Kafka developers can use the AsyncAPI specification to describe how their applications are using Kafka topics
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
For those using OAI3.0, OAI2 or AsyncAPI then the same capability can be used by adding an ‘ x-ibm-summary ’ field to the info object in your API document