OpenAPI

Overview

This plugin allows you to import your OpenAPI directly into EventCatalog to generate domains, services, channels and messages. EventCatalog will transform your OpenAPI specifications into rich documentation and visualizations for your teams to understand.

Get more value from your OpenAPI specifications, with automatic versioning, visualizations and more.

Core Features

The EventCatalog OpenAPI plugin can provide you with many features:

• Generate domains, services and messages into your catalog from your OpenAPI specification files
• Automate your EventCatalog and fetch OpenAPI files by URL
• Map commands, queries and events from your OpenAPI file using custom extensions
• Add semantic meaning to your OpenAPI files, persist this meaning between versions
• Automatically version your changes in EventCatalog in sync with your OpenAPI versions
• Render and display your OpenAPI specification in EventCatalog
• Display your endpoints and parameters in the catalog
• Ability to download your schemas and OpenAPI files (also versioned)
• and more....

Examples

You can view our examples of this plugin on GitHub:

• OpenAPI Example
• Fetch and parse OpenAPI files from remote URLs
• Version OpenAPI messages in EventCatalog
• Map OpenAPI routes to commands, events and queries

Configure

Install and configure the plugin directly with your EventCatalog project. Use custom EventCatalog headers to map your OpenAPI messages into events, commands and queries.