Skip to main content

Introduction

View as Markdown

Many teams building event-driven architectures use schema registries to manage their message schemas and API specifications.

Apicurio Registry is an open-source schema registry that provides a centralized location to store and manage schemas for your event-driven applications. It supports multiple schema formats including Avro, JSON Schema, Protobuf, AsyncAPI, and OpenAPI.

We believe schema registries are a great foundation, but there's significant value in adding semantic meaning to your schemas, assigning them to services and domains, and creating comprehensive documentation around your architecture.

The EventCatalog Apicurio Registry plugin allows you to import your schemas and specifications from Apicurio Registry into EventCatalog. Keep your architecture documentation in sync with your registry while unlocking additional visualization and documentation capabilities.

info

What is Apicurio Registry?: An open-source schema registry for event-driven architectures. Use it to store and manage your event schemas and API specifications. Learn more at the Apicurio website.

Core Features of the Apicurio Registry plugin​

The EventCatalog Apicurio Registry plugin provides you with many powerful features:

  • ⭐️ Import schemas and specifications from your Apicurio Registry into EventCatalog
  • ⭐️ Keep schemas in sync with your architecture documentation
  • ⭐️ Automatic versioning - as your schemas change they are versioned in EventCatalog alongside your documentation
  • ⭐️ Support for multiple schema formats (Avro, JSON Schema, Protobuf, AsyncAPI, OpenAPI)
  • ⭐️ Add semantic meaning (markdown) to your schemas - provide business context and added value
  • ⭐️ Use custom filters (prefix, suffix, exact matches) to select which schemas to import
  • ⭐️ Assign schemas to services and domains
  • ⭐️ Document your schemas as commands, events, or queries
  • ⭐️ Integrate with OpenAPI and AsyncAPI plugins to generate complete service documentation
  • ⭐️ Visualize your event-driven architecture with the EventCatalog Visualizer
  • ⭐️ Download and view schemas directly in EventCatalog
  • ⭐️ Talk to your schemas, services, and domains with the EventCatalog Chat
  • ⭐️ Support for Bearer token authentication for secured registries
  • ⭐️ and more....

How it works​

  1. Install the Apicurio Registry plugin
  2. Configure the plugin (schemas, services, domains, specifications)
  3. Run the plugin to import your schemas into EventCatalog
  4. View and deploy your catalog

Apicurio Registry plugin

What are generators?

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 Apicurio Registry plugin is a generator. It will import your schemas and specifications from your Apicurio Registry into EventCatalog.

License​

This plugin is open source under the MIT License and doesn't need a license key.

Need a demo?​

If you would like a demo of the plugin, please feel free to reach out to us and book a time to chat at hello@eventcatalog.dev.

Any questions or need help?​

If you have questions or need help, you can join our Discord community or raise an issue on GitHub.