Introduction

View as Markdown

---

Added in eventcatalog@2.5.0

License: Dual-license

---

Many folks building event-driven architectures are using and defining AsyncAPI files. The files are used to describe the service, it's messages it sends and receives and channels it uses to communicate.

Using the EventCatalog AsyncAPI generator you can generate and maintain your EventCatalog.

Try it now

Want to see what your AsyncAPI file looks like in EventCatalog? Try the playground — drop your file and see the result in seconds.

info

What is AsyncAPI?: An industry standard for defining asynchronous APIs. Use this specification to document your service, channels and messages.

Core Features

The EventCatalog AsyncAPI plugin can provide you with many features:

• ⭐️ Generate domains, services and messages into your catalog from your AsyncAPI specification files
• ⭐️ Automate your EventCatalog and fetch AsyncAPI files by URL
• ⭐️ Map commands, queries and events from your OpenAPI file using custom extensions
• ⭐️ Automatically version your changes in EventCatalog in sync with your AsyncAPI versions
• ⭐️ Allow you to write and persist custom markdown between changes
• ⭐️ Display your message schemas in the catalog
• ⭐️ Fetch AsyncAPI files from any URL
• ⭐️ Ability to download your message schemas and AsyncAPI files (also versioned)
• ⭐️ Ability to draft services and endpoints in EventCatalog from your AsyncAPI files
• ⭐️ and more....

How it works

EventCatalog supports generators. These are scripts or plugins that can be run to integrate with any external API, system or specification files. EventCatalog also provides an SDK to give developers easier access to their catalogs through custom scripts or generators.

The EventCatalog AsyncAPI plugin let's you define 1 or many AsyncAPI files. When running the generate command the scripts populate your eventcatalog. You can choose how your AsyncAPI services are added to EventCatalog and which domain they belong to.

Commercial and License

This plugin requires an EventCatalog Scale license key to be used.

You can get a 30-day trial Scale license key by going to EventCatalog Cloud.

After the trial, you can continue using this plugin with EventCatalog Scale.

See pricing for more information.

Have any questions? You can email us at hello@eventcatalog.dev.

License FAQ

What is the license key for?

The EventCatalog Scale license key is required to use the OpenAPI plugin with EventCatalog. It helps support ongoing development and maintenance of the plugin and project.

How do I get an EventCatalog Scale license key?

You can obtain an EventCatalog Scale license key by visiting EventCatalog Cloud. New users can start with a 30-day free trial.

Terms

• Trial Period: 30-day free trial no credit card required
• Support: Discord community support (extra for priority support)

After your trial period ends, you can continue with EventCatalog Scale through EventCatalog Cloud.