Skip to main content
New project sponsor 🪝Hookdeck: Serverless infrastructure for event-driven architecture. Learn more.

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 add the specifications frontmatter API to your service.

Example
---
  specifications:
    openapiPath: openapi.yml
---

This will render a new badge on your page and a new button to load the OpenAPI page for your service.

Example

Adding an AsyncAPI specification files​

Services in EventCatalog allow you to render AsyncAPI specifications files.

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

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

Next add the specifications frontmatter API to your service.

Example
---
  specifications:
    asyncapiPath: asyncapi.yml
---

This will render a new badge on your page and a new button to load the AsyncAPI page for your service.

Example

Automate your EventCatalog from your AsyncAPI files

Did you know you can use the AsyncAPI generator to generate your EventCatalog? Check out the AsyncAPI integration for more information.