Configuration d’AsyncAPI

Créez des pages de référence WebSocket avec AsyncAPI

​

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 être compatible avec la spécification AsyncAPI 3.0+.

Pour vérifier la validité de votre schéma AsyncAPI, vous pouvez le coller dans AsyncAPI Studio

​

Remplissage automatique des 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 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é, ou 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 :

Local File

"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": "référence-api"
          }
        }
      ]
    }
  ]
}

Le champ directory est facultatif. S’il n’est pas renseigné, les fichiers seront placés dans le dossier api-reference du dépôt des docs.

​

Page de canal

Si vous souhaitez mieux contrôler l’ordre de vos canaux ou simplement faire référence à un canal unique, vous pouvez créer un fichier MDX avec le champ asyncapi dans le frontmatter.

---
title: "Canal WebSocket"
asyncapi: "/path/to/asyncapi.json channelName"
---