Skip to main content

Adding AsyncAPI Specifications

With EventCatalog you can add your AsyncAPI Specifications to your services, or if you prefer to render pages based on your AsyncAPI spec then you can read the AsyncAPI Plugin.

To use the feature you will need to do two things:

  1. Add your asyncapi.yaml file into your service
    • example /services/{Your Service}/asyncapi.yaml
  2. Add the Component AsyncAPI inside your service markdown file.

This will load your AsyncAPI file into your Service Page.

Example of loading AsyncAPI 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.

<AsyncAPI />

Example Output​

AsyncAPI Example