AsyncAPI setup

Set up real-time WebSocket documentation using AsyncAPI specification files to generate interactive channel and message reference pages.

Demo

See the WebSocket playground for an example of the AsyncAPI playground.

Add an AsyncAPI specification file

To create pages for your WebSocket channels, you must have a valid AsyncAPI schema document in either JSON or YAML format that follows the AsyncAPI specification 3.0.

Use the AsyncAPI Studio to validate your AsyncAPI schema.

/your-project
  |- docs.json
  |- asyncapi.json

Auto-populate WebSocket pages

To automatically generate pages for all channels in your AsyncAPI schema, add an asyncapi property to any navigation element. The asyncapi property accepts a path to an AsyncAPI schema document in your documentation repo, a URL to a hosted AsyncAPI document, or an array of links to AsyncAPI schema documents.

Examples with tabs

Local file

"navigation": {
  "tabs": [
    {
        "tab": "API Reference",
        "asyncapi": "/path/to/asyncapi.json"
    }
  ]
}

When you specify multiple AsyncAPI files, each file generates its own set of channel pages.

Examples with groups

"navigation": {
  "tabs": [
    {
      "tab": "AsyncAPI",
      "groups": [
        {
          "group": "Websockets",
          "asyncapi": {
            "source": "/path/to/asyncapi.json",
            "directory": "websockets"
          }
        }
      ]
    }
  ]
}

The directory field is optional. If not specified, Mintlify adds the files to the api-reference folder of the docs repository.

Examples with nested groups

The asyncapi property supports nested groups. Mintlify generates the channel pages and adds them to the nested group, alongside any existing pages.

This is useful when you want to organize WebSocket channels as a subsection of a broader API group, or when you need to combine multiple AsyncAPI specifications under a shared parent group.

"navigation": {
  "tabs": [
    {
      "tab": "API Reference",
      "groups": [
        {
          "group": "Voice API",
          "pages": [
            "voice/overview",
            {
              "group": "Voice API Commands",
              "asyncapi": "/path/to/voice-asyncapi.json"
            }
          ]
        }
      ]
    }
  ]
}

Channel page

If you want more control over how you order your channels or if you want to reference only specific channels, create an MDX file with the asyncapi property in the frontmatter.

---
title: "Websocket Channel"
asyncapi: "/path/to/asyncapi.json channelName"
---