Skip to main content
⭐️ If you love EventCatalog, give it a star on GitHub. Thanks!

Adding specifications to services

Adding an OpenAPI specification file

Services in EventCatalog allow you to render OpenAPI specification files or schemas on the page.

To add an OpenAPI file to your service you will need to include the file itself inside the service directory.

  • /services/{Service Name}/openapi.yml
    • (example /services/Orders/openapi.yml)

Next include the <OpenAPI/> component inside your markdown file.

...

This is my awesome service.

<!-- This will load the OpenAPI document in your service and create a link in the side navigation to view it. -->
<OpenAPI/>

...

This will render out a new component on your page, allowing users to see the specification file.

Example