Configuración de AsyncAPI

Crea páginas de referencia de WebSocket con AsyncAPI

​

Añade un archivo de especificación de AsyncAPI

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. Tu esquema debe ajustarse a la especificación de AsyncAPI 3.0 o superior.

Para verificar que tu esquema de AsyncAPI sea válido, puedes pegarlo en AsyncAPI Studio

​

Autogenerar páginas de websockets

Puedes agregar un campo asyncapi a cualquier tab o grupo en la navigation 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 hospedado o un arreglo de enlaces a documentos de esquema de AsyncAPI. Mintlify generará automáticamente una página para cada canal de websocket de AsyncAPI.

Ejemplos con Tabs:

Local File

"navigation": {
  "tabs": [
    {
        "tab": "API Reference",
        "asyncapi": "/path/to/asyncapi.json"
    }
  ]
}

Ejemplos con Groups:

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

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

​

Página de canal

Si quieres tener más control sobre el orden de tus canales, o si solo quieres hacer referencia a un canal específico, puedes crear un archivo MDX con el campo asyncapi en el frontmatter.

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