Apicurio Registry

Overview

This plugin allows you to import your Apicurio Registry schemas and specifications into EventCatalog, keeping them in sync with your documentation.

With EventCatalog you can add semantic meaning to your schemas, and optionally assign them to services, domains and owners. You can also integrate OpenAPI and AsyncAPI specifications stored in your registry to generate comprehensive service documentation.

Core Features

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

• Import schemas from Apicurio Registry - Import all schemas or filter specific ones you want to document
• Support for multiple schema formats - Avro, JSON Schema, Protobuf, AsyncAPI, OpenAPI, and more
• Automatic versioning - Track all versions of your schemas with includeAllVersions option
• Service assignment - Assign schemas to services (producers and consumers) using flexible filters
• Message type classification - Document schemas as events, commands, or queries for semantic clarity
• Flexible filtering system - Use exact matching, prefix, suffix, or includes filters to organize schemas
• Domain organization - Assign services and schemas to domains for better architecture visualization
• OpenAPI/AsyncAPI integration - Attach specifications and use nested generators for complete documentation
• Add semantic meaning - Let your teams understand the business context and purpose of your schemas
• Service relationships - Document service-to-service communication with writesTo and readsFrom
• Visualize your architecture - Use the EventCatalog Visualizer to see how schemas, services and domains connect
• EventCatalog Chat - Talk to your schemas, services, and domains to get insights in seconds
• Persistent documentation - Your semantic meaning is preserved between schema version updates
• Bearer token authentication - Support for secured Apicurio Registry instances