OpenAPI

Overview

Your OpenAPI specs define your APIs. EventCatalog makes them discoverable, versioned, and visible across your entire organization.

Point the OpenAPI plugin at your specification files and EventCatalog generates domains, services, and messages automatically. You get visualizations, relationship mapping, and version history out of the box. Your teams get a single place to find, understand, and track every API in your architecture.

You can also document who is consuming your APIs to help you quickly find downstream consumers of your APIs.

No more digging through repositories to find the right spec. No more outdated Confluence pages describing endpoints that changed three sprints ago.

Try the playground → — Drop your OpenAPI file and see the result in seconds.

Core Features

• Generate domains, services, and messages from your OpenAPI specification files — your catalog stays in sync with your specs
• Fetch OpenAPI files by URL — automate your catalog from remote specs in CI/CD
• Map routes to commands, queries, and events with OpenAPI extensions — add architectural meaning to your API endpoints
• Persist custom markdown between versions — add context and documentation that survives spec updates
• Automatic versioning in sync with your OpenAPI versions — track every change with full version history
• Render your OpenAPI specification directly in EventCatalog — teams explore your APIs without switching tools
• Download schemas and OpenAPI files — versioned alongside your documentation

Examples

• OpenAPI Example — basic setup and generation
• Fetch from remote URLs — pull specs from any URL
• Version OpenAPI messages — independent message versioning
• Map routes to commands, events, and queries — custom extensions in action

Configure

Add the plugin to your EventCatalog project and start generating documentation from your OpenAPI specs. Use OpenAPI extensions to map routes into events, commands, and queries.