Introduction

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.

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)
• ⭐️ 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 is governed by a dual-license. To ensure the sustainability of the project.

You can get a 14 day trial license key to try the plugin out by going to EventCatalog Cloud.

After the trial you can purchase a license to continue using this plugin.

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

License FAQ

What is the license key for?

The 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 a license key?

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

Terms

• Usage: Any many catalogs as you like in your organization
• Trial Period: 14 days free trial no credit card required
• Support: Discord community support (extra for priority support)

After your trial period ends, you can purchase a full license through EventCatalog Cloud to continue using the plugin.