Skip to main content

OpenAPI integration with EventCatalog

· 2 min read
David Boyne
David Boyne
Founder of EventCatalog

Last week we launched the new AsyncAPI Plugin and today I'm happy to share we have now launched our next integration: OpenAPI Plugin.

The EventCatalog OpenAPI plugin connects your OpenAPI files to EventCatalog and automates the hydration of your catalog, versioning and schema management.

What is OpenAPI?​

The OpenAPI specification is a widely-adopted standard for defining and describing RESTful APIs in a structured, machine-readable format. It provides a way to document APIs, including the endpoints, parameters, request and response formats, authentication methods, and more, making it easier for both humans and machines to understand and interact with the API.

Why integration with EventCatalog​

For many years people have been using OpenAPI specifications to help document their APIS.

Integrating with OpenAPI specifications allows users of EventCatalog to generate their services, map them to domains, visually see there architecture, parameters, responses and payloads.

Our vision with EventCatalog is to help companies manage event-driven architecture discoverability and it's complexity through documentation and integration tools. Part of this vision is to automate some of this complexity and documentation for you. That's why we have integrated with OpenAPI.

How the plugin works​

EventCatalog can be powered by generators. Generators can be used to automate the creation of your EventCatalog.

The OpenAPI generator takes your OpenAPI files and transforms them into living documentation.

Image

The OpenAPI generator will:

  • 📃 Document domains, services and messages from your OpenAPI file (example)
  • 📊 Visualise your architecture
  • ⭐ Download your OpenAPI files
  • 💅 Custom MDX components
  • 🗄️ Auto versioning of your domains, services and messages
  • ⭐ Discoverability feature (search, filter and more)
  • ⭐ And much more...

Getting started​

To get started you can read the documentation or see the example project.

Summary​

EventCatalog is vendor and technology agnostic. This allow us to integrate with any system in the world and we already have a backlog of plugins (Backstage, OpenAPI, GitHub, AWS, Azure, Google, Solace, Gravitee and more...).

Today we launched our OpenAPI integration which allows you to automate your EventCatalog.

If you have any questions you can join us on our Discord server.