Configuration d’AsyncAPI

Créez une documentation WebSocket avec des spécifications AsyncAPI.

​

Démo

Consultez l’aire de jeu WebSocket pour un exemple de l’aire de jeu AsyncAPI.

​

Ajouter un fichier de spécification AsyncAPI

Pour créer des pages pour vos WebSockets, vous devez disposer d’un document de schéma AsyncAPI valide, au format JSON ou YAML, conforme à la spécification AsyncAPI 3.0+.

Utilisez AsyncAPI Studio pour valider votre schéma AsyncAPI.

/votre-projet
  |- docs.json
  |- asyncapi.json

​

Générer automatiquement les pages WebSocket

Pour générer automatiquement des pages pour tous les canaux de votre schéma AsyncAPI, ajoutez une propriété asyncapi à n’importe quel élément de navigation. La propriété asyncapi accepte soit un chemin vers un document de schéma AsyncAPI dans votre dépôt de documentation, soit une URL vers un document AsyncAPI hébergé, soit un tableau de liens vers des documents de schéma AsyncAPI.

​

Exemples avec onglets

Local file

"navigation": {
  "tabs": [
    {
        "tab": "Référence de l’API",
        "asyncapi": "/path/to/asyncapi.json"
    }
  ]
}

​

Exemples avec des groupes

"navigation": {
  "tabs": [
    {
      "tab": "AsyncAPI",
      "groups": [
        {
          "group": "Websockets",
          "asyncapi": {
            "source": "/path/to/asyncapi.json",
            "directory": "websockets"
          }
        }
      ]
    }
  ]
}

Le champ directory est facultatif. S’il n’est pas indiqué, 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 ne référencer que certains canaux, créez un fichier MDX avec la propriété asyncapi dans le frontmatter.

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