​
Ajouter un fichier de spécification AsyncAPI

Pour commencer à créer des pages pour vos websockets, assurez-vous de disposer d’un document de schéma AsyncAPI valide, au format JSON ou YAML, conforme à la spécification AsyncAPI. Votre schéma doit respecter la spécification AsyncAPI 3.0+.
Pour vérifier la validité de votre schéma AsyncAPI, vous pouvez le coller dans AsyncAPI Studio

​
Remplir automatiquement les pages WebSocket

Vous pouvez ajouter un champ asyncapi à n’importe quel onglet ou groupe dans la navigation de votre docs.json. Ce champ peut contenir soit le chemin vers un document de schéma AsyncAPI dans votre dépôt de documentation, l’URL d’un document de schéma AsyncAPI hébergé, soit un tableau de liens vers des documents de schéma AsyncAPI. Mintlify générera automatiquement une page pour chaque canal WebSocket AsyncAPI. Exemples avec des onglets : 
"navigation": {
  "tabs": [
    {
        "tab": "API Reference",
        "asyncapi": "/path/to/asyncapi.json"
    }
  ]
}
Exemples avec des groupes : 
"navigation": {
  "tabs": [
    {
      "tab": "AsyncAPI",
      "groups": [
        {
          "group": "Websockets",
          "asyncapi": {
            "source": "/path/to/asyncapi.json",
            "directory": "api-reference"
          }
        }
      ]
    }
  ]
}
Le champ directory est facultatif. S’il n’est pas spécifié, les fichiers seront placés dans le dossier api-reference du dépôt de documentation.

​
Page de canal

Si vous souhaitez mieux contrôler l’ordre de vos canaux ou simplement référencer un seul canal, vous pouvez créer un fichier MDX avec le champ asyncapi dans le frontmatter. 
---
title: "Websocket Channel"
asyncapi: "/path/to/asyncapi.json channelName"
---