Aggiungi un file di specifica AsyncAPI

Per iniziare a creare pagine per i tuoi WebSocket, assicurati di avere un documento di schema AsyncAPI valido in formato JSON o YAML che rispetti la specifica AsyncAPI. Il tuo schema deve essere conforme alla specifica AsyncAPI 3.0+.
Per verificare che il tuo schema AsyncAPI sia valido, puoi incollarlo in AsyncAPI Studio

Popolare automaticamente le pagine WebSocket

Puoi aggiungere un campo asyncapi a qualsiasi tab o gruppo nella navigazione del tuo docs.json. Questo campo può contenere il percorso di un documento di schema AsyncAPI nel tuo repository della documentazione, l’URL di un documento di schema AsyncAPI ospitato oppure un array di link a documenti di schema AsyncAPI. Mintlify genererà automaticamente una pagina per ogni canale WebSocket di AsyncAPI. Esempi con Tabs:
"navigation": {
  "tabs": [
    {
        "tab": "API Reference",
        "asyncapi": "/path/to/asyncapi.json"
    }
  ]
}

Esempi con Groups:
"navigation": {
  "tabs": [
    {
      "tab": "AsyncAPI",
      "groups": [
        {
          "group": "Websockets",
          "asyncapi": {
            "source": "/path/to/asyncapi.json",
            "directory": "api-reference"
          }
        }
      ]
    }
  ]
}
Il campo directory è facoltativo. Se non specificato, i file verranno inseriti nella cartella api-reference del repository della documentazione.

Pagina canale

Se vuoi avere più controllo sull’ordinamento dei canali o vuoi semplicemente fare riferimento a un singolo canale, puoi creare un file MDX con il campo asyncapi nel frontmatter.
---
title: "Websocket Channel"
asyncapi: "/path/to/asyncapi.json channelName"
---