Setup

Agregar un archivo de especificación AsyncAPI

Para comenzar a crear páginas para sus websockets, asegúrese de tener un documento de esquema AsyncAPI válido en formato JSON o YAML que siga laespecificación AsyncAPI. Su esquema debe seguir la especificación AsyncAPI 3.0+.

Para asegurarse de que su esquema AsyncAPI es válido, puede pegarlo en el AsyncAPI Studio

Auto-poblar páginas de websockets

Puede agregar un campoasyncapia cualquier pestaña o grupo en la navegación de sudocs.json. Este campo puede contener la ruta a un documento de esquema AsyncAPI en el repositorio de su documentación, la URL de un documento de esquema AsyncAPI alojado, o un array de enlaces a documentos de esquema AsyncAPI. Mintlify generará automáticamente una página para cada canal de websocket AsyncAPI.

Ejemplos con Pestañas:

Local File

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

Ejemplos con Grupos:

"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 colocarán en la carpetaapi-referencedel repositorio de documentación.

Página de Canal

Si desea tener más control sobre cómo ordena sus canales o si solo quiere hacer referencia a un solo canal, puede crear un archivo MDX con el campoasyncapien el frontmatter.

---
title: "Websocket Channel"
asyncapi: "/path/to/asyncapi.json channelName"
---