Skip to main content

EventCatalog and OpenAPI

· 2 min read
David Boyne

cover

We are happy to announce that users can now use OpenAPI to help them document their services within EventCatalog!

This is a great feature from Rodolfo Toro ⭐️

This feature will allow you to easily display Swagger UI within EventCatalog in a few steps..

EventCatalog is focused on making Event Architecture documentation simple and useful. Having OpenAPI support for your services is another great reason to try out EventCatalog to help you document your Event Architectures.

info

Want to see the Demo? You can view it here: https://app.eventcatalog.dev/services/Payment%20Service/

How does EventCatalog work with OpenAPI?​

EventCatalog allows you to document your events, domains and services using Markdown and custom components.

We have now introduced a new component that allows you to display your OpenAPI spec files within any of your services.

You can add OpenAPI specification files to your services following these steps:

  1. Add your openapi.yaml or openapi.json file into your service
    • example /services/{Your Service}/openapi.yaml
  2. Add the Component OpenAPI inside your service markdown file.

This will load your OpenAPI file into your Service Page.

Example of loading OpenAPI into Service file
---
name: Payment Service
summary: |
  Event based application that integrates with Stripe.
owners:
  - dboyne
---

The payment service is our own internal payment service that listens to events from stripe and handles them within our own domain. 

We use Stripe to handle services and use this Payment service to enrich events for internal use.

<OpenAPI />

<NodeGraph />


Example Output​

OpenAPI Example

info

Want to see the Demo? You can view it here: https://app.eventcatalog.dev/services/Payment%20Service/

How can you get started?​

If you already have EventCatalog then you will need to add the file openapi.yaml or openapi.json to your service folder. Then add the <OpenAPI /> component to your Markdown.

If you have yet to try EventCatalog, head over to our getting started guide, where you can get a catalog started within minutes using our NPM packages.

Summary​

This is a great feature from Rodolfo Toro and it is starting to show how the EventCatalog community is starting to grow!

Thank you Rodolfo Toro for your great contribution and we hope you all find it useful!

If you have any ideas or feedback feel free to raise an issue on GitHub or come join us on Discord.

Enjoy!