Configuración de AsyncAPI

Demostración

Consulta el playground de WebSocket para ver un ejemplo del playground de AsyncAPI.

Agrega un archivo de especificación de AsyncAPI

Para crear páginas para tus websockets, debes contar con un documento de esquema de AsyncAPI válido en formato JSON o YAML que cumpla con la especificación de AsyncAPI 3.0+.

Usa AsyncAPI Studio para validar tu esquema de AsyncAPI.

/tu-proyecto
  |- docs.json
  |- asyncapi.json

Autogenerar páginas de websockets

Para generar automáticamente páginas para todos los canales de tu esquema AsyncAPI, agrega la propiedad asyncapi a cualquier elemento de navegación. La propiedad asyncapi acepta una ruta a un documento de esquema AsyncAPI en tu repositorio de documentación, una URL a un documento AsyncAPI alojado o una matriz de enlaces a documentos de esquema AsyncAPI.

Ejemplos con pestañas

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

"navigation": {
  "tabs": [
    {
        "tab": "API Reference",
        "asyncapi": "https://github.com/asyncapi/spec/blob/master/examples/simple-asyncapi.yml"
    }
  ]
}

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

Cuando especificas varios archivos AsyncAPI, cada archivo genera su propio conjunto de páginas de canales.

Ejemplos con grupos

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

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

Página de canal

Si quieres tener más control sobre el orden de tus canales o necesitas referirte solo a canales específicos, crea un archivo MDX con la propiedad asyncapi en el frontmatter.

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

Comenzar

Organizar

Personalizar

Crear contenido

Documentar APIs

Implementar

Optimizar

Demostración

Agrega un archivo de especificación de AsyncAPI

Autogenerar páginas de websockets

Ejemplos con pestañas

Ejemplos con grupos

Página de canal

​Demostración

​Agrega un archivo de especificación de AsyncAPI

​Autogenerar páginas de websockets

​Ejemplos con pestañas

​Ejemplos con grupos

​Página de canal

Demostración

Agrega un archivo de especificación de AsyncAPI

Autogenerar páginas de websockets

Ejemplos con pestañas

Ejemplos con grupos

Página de canal