Skip to main content

​
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 JSON or YAML format. The document must follow the AsyncAPI specification 3.0.
Use the AsyncAPI Studio to validate your AsyncAPI schema.

​
Auto-populate WebSocket pages

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

​
Examples with tabs

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

​
Examples with groups

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. Use nested groups to organize WebSocket channels as a subsection of a broader API group. You can also combine multiple AsyncAPI specifications under a shared parent group.

​
Schema rendering

Array schemas and combinatorial schemas (oneOf, anyOf, allOf) expand to show their child attributes inline in the generated channel pages. Readers can open the expandable section for an array item schema. They can also select a tab for each oneOf/anyOf option to see all nested fields.

​
Channel page

To control channel order or reference only specific channels, create an MDX file with the asyncapi property in the frontmatter.