Skip to main content

AsyncAPI integration with EventCatalog

· 3 min read
David Boyne
David Boyne
Founder of EventCatalog

I'm happy to share the first integration plugin for EventCatalog has been released.

The EventCatalog AsyncAPI plugin connects your AsyncAPI files to EventCatalog and automates the hydration of your catalog, versioning and schema management.

What is AsyncAPI?​

The AsyncAPI specification is the industry standard for defining asynchronous APIs, with AsyncAPI you can define your servers, channels and messages. This gives architects and developers the ability to document their asynchronous APIs using an open standard.

From the website directly:

AsyncAPI is an open source initiative that seeks to improve the current state of Event-Driven Architectures (EDA). Our long-term goal is to make working with EDAs as easy as working with REST APIs. That goes from documentation to code generation, from discovery to event management, and beyond. (read more)

AsyncAPI is part of the Linux foundation has a fantastic tools defined and community behind the project.

Why integration with EventCatalog​

Over the past few years AsyncAPI has gained momentum and has become a great standard to help you document and govern your event-driven architectures. Many companies including LEGO, Zora Robotics, Walmart and Ebay are using AsyncAPI to help them build their event-driven architectures.

Our vision with EventCatalog is to help companies manage event-driven architecture discoverability and it's complexity through documentation and integration tools. Part of this vision is to automate some of this complexity and documentation for you. That's why we have integrated with AsyncAPI.

How the plugin works​

EventCatalog can be powered by generators. Generators can be used to automate the creation of your EventCatalog.

The AsyncAPI generator takes your AsyncAPI files and transform them into living documentation.

Image

The AsyncAPI generator will:

  • 📃 Document domains, services and messages from your AsyncAPI file (example)
  • 📊 Visualise your architecture (demo)
  • ⭐ Download your AsyncAPI files and message schemas form EventCatalog (e.g Avro, JSON) (demo)
  • 💅 Custom MDX components (read more)
  • 🗄️ Auto versioning of your domains, services and messages
  • ⭐ Discoverability feature (search, filter and more) (demo)
  • ⭐ And much more...

Getting started​

To get started you can read the documentation or see the example project.

You can also watch the video to learn more.

Summary​

EventCatalog is vendor and technology agnostic. This allow us to integrate with any system in the world and we already have a backlog of plugins (Backstage, OpenAPI, GitHub, AWS, Azure, Google, Solace, Gravitee and more...).

Today we launched our first integration with AsyncAPI which allows you to automate your EventCatalog.

If you have any questions you can join us on our Discord server.