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

# Configuración de AsyncAPI

> Crea páginas de referencia de websocket con AsyncAPI

<div id="add-an-asyncapi-specification-file">
  ## Agrega un archivo de especificación de AsyncAPI
</div>

Para empezar a crear páginas para tus websockets, asegúrate de contar con un documento de esquema de AsyncAPI válido en formato JSON o YAML que cumpla con la [especificación de AsyncAPI](https://www.asyncapi.com/docs/reference/specification/v3.0.0). Tu esquema debe ajustarse a la especificación 3.0+ de AsyncAPI.

<Tip>
  Para comprobar que tu esquema de AsyncAPI sea válido, puedes pegarlo en
  [AsyncAPI Studio](https://studio.asyncapi.com/)
</Tip>

<div id="auto-populate-websockets-pages">
  ## Autogenerar páginas de websockets
</div>

Puedes agregar un campo `asyncapi` a cualquier pestaña o grupo en la navegación de tu `docs.json`. Este campo puede contener la ruta a un documento de esquema de AsyncAPI en tu repositorio de documentación, la URL de un documento de esquema de AsyncAPI alojado o una matriz de enlaces a documentos de esquema de AsyncAPI. Mintlify generará automáticamente una página para cada canal de websocket de AsyncAPI.

**Ejemplos con pestañas:**

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

  ```

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

**Ejemplos con grupos:**

```json {8-11}
"navigation": {
  "tabs": [
    {
      "tab": "AsyncAPI",
      "groups": [
        {
          "group": "WebSockets",
          "asyncapi": {
            "source": "/path/to/asyncapi.json",
            "directory": "referencia-api"
          }
        }
      ]
    }
  ]
}
```

<Note>
  El campo directory es opcional. Si no se especifica, los archivos se ubicarán en
  la carpeta **api-reference** del repositorio de docs.
</Note>

<div id="channel-page">
  ## Página de canal
</div>

Si quieres tener más control sobre el orden de tus canales o simplemente referenciar un canal específico, puedes crear un archivo MDX con el campo `asyncapi` en el frontmatter.

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