Setup

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 aespecificação AsyncAPI. Seu esquema deve seguir a especificação AsyncAPI 3.0+.

Para garantir que seu esquema AsyncAPI seja válido, você pode colá-lo no AsyncAPI Studio

Preencher automaticamente páginas de websockets

Você pode adicionar um campoasyncapia qualquer aba ou grupo na navegação do seudocs.json. Este campo pode conter o caminho para um documento de esquema AsyncAPI em seu repositório de documentação, a URL de um documento de esquema AsyncAPI hospedado, ou uma matriz de links para documentos de esquema AsyncAPI. O Mintlify gerará automaticamente uma página para cada canal de websocket AsyncAPI.

Exemplos com Abas:

Local File

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

Exemplos com Grupos:

"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 pastaapi-referencedo repositório de documentação.

Página do Canal

Se você quiser mais controle sobre como ordenar seus canais ou se quiser apenas referenciar um único canal, você pode criar um arquivo MDX com o campoasyncapino frontmatter.

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