> ## Documentation Index
> Fetch the complete documentation index at: https://omer-914cc1c6.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Configuration d’AsyncAPI

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

<div id="add-an-asyncapi-specification-file">
  ## Ajouter un fichier de spécification AsyncAPI
</div>

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](https://www.asyncapi.com/docs/reference/specification/v3.0.0). Votre schéma doit respecter la spécification AsyncAPI 3.0+.

<Tip>
  Pour vérifier la validité de votre schéma AsyncAPI, vous pouvez le coller dans
  [AsyncAPI Studio](https://studio.asyncapi.com/)
</Tip>

<div id="auto-populate-websockets-pages">
  ## Remplissage automatique des pages WebSocket
</div>

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 d’accès 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 Tabs :**

<CodeGroup>
  ```json Local File {5} theme={null}
  "navigation": {
    "tabs": [
      {
          "tab": "API Reference",
          "asyncapi": "/path/to/asyncapi.json"
      }
    ]
  }

  ```

  ```json Remote URL {5} theme={null}
  "navigation": {
    "tabs": [
      {
          "tab": "API Reference",
          "asyncapi": "https://github.com/asyncapi/spec/blob/master/examples/simple-asyncapi.yml"
      }
    ]
  }
  ```
</CodeGroup>

**Exemples avec des Groups :**

```json {8-11} theme={null}
"navigation": {
  "tabs": [
    {
      "tab": "AsyncAPI",
      "groups": [
        {
          "group": "Websockets",
          "asyncapi": {
            "source": "/path/to/asyncapi.json",
            "directory": "api-reference"
          }
        }
      ]
    }
  ]
}
```

<Note>
  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.
</Note>

<div id="channel-page">
  ## Page des canaux
</div>

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

```mdx theme={null}
---
title: "Canal WebSocket"
asyncapi: "/path/to/asyncapi.json channelName"
---
```