​
Adicionar um arquivo de especificação AsyncAPI

Para começar a criar páginas para seus WebSockets, certifique-se de ter um documento de esquema AsyncAPI válido, em formato JSON ou YAML, que siga a especificação AsyncAPI. Seu esquema deve estar em conformidade com a especificação AsyncAPI 3.0+.
Para verificar se seu esquema AsyncAPI é válido, você pode colá-lo no AsyncAPI Studio

​
Preencher automaticamente páginas de WebSockets

Você pode adicionar um campo asyncapi a qualquer aba ou grupo na navegação do seu docs.json. Esse campo pode conter o caminho para um documento de esquema AsyncAPI no seu repositório de docs, a URL de um documento de esquema AsyncAPI hospedado ou um array de links para documentos de esquema AsyncAPI. O Mintlify gerará automaticamente uma página para cada canal WebSocket do AsyncAPI. Exemplos com Tabs: 
"navigation": {
  "tabs": [
    {
        "tab": "API Reference",
        "asyncapi": "/path/to/asyncapi.json"
    }
  ]
}
Exemplos com Groups: 
"navigation": {
  "tabs": [
    {
      "tab": "AsyncAPI",
      "groups": [
        {
          "group": "Websockets",
          "asyncapi": {
            "source": "/path/to/asyncapi.json",
            "directory": "api-reference"
          }
        }
      ]
    }
  ]
}
O campo directory é opcional. Se não for especificado, os arquivos serão colocados na pasta api-reference do repositório de docs.

​
Página de canal

Se você quiser ter mais controle sobre a ordem dos seus canais ou apenas referenciar um único canal, crie um arquivo MDX com o campo asyncapi no frontmatter. 
---
title: "Canal WebSocket"
asyncapi: "/path/to/asyncapi.json channelName"
---