Introduction
eventcatalog@2.5.0Many 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.
Want to see what your AsyncAPI file looks like in EventCatalog? Try the playground — drop your file and see the result in seconds.
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.
License
This plugin is open source under the MIT License and doesn't need a license key.