​
Eine AsyncAPI-Spezifikationsdatei hinzufügen

Um mit dem Erstellen von Seiten für Ihre WebSockets zu beginnen, stellen Sie sicher, dass Sie ein gültiges AsyncAPI-Schemadokument im JSON- oder YAML-Format haben, das der AsyncAPI-Spezifikation entspricht. Ihr Schema muss der AsyncAPI-Spezifikation ab Version 3.0 folgen.
Um die Gültigkeit Ihres AsyncAPI-Schemas zu überprüfen, können Sie es in das AsyncAPI Studio einfügen.

​
Websocket-Seiten automatisch befüllen

Sie können in der Navigation Ihrer docs.json jedem Tab oder jeder Gruppe ein asyncapi-Feld hinzufügen. Dieses Feld kann entweder den Pfad zu einem AsyncAPI-Schemadokument in Ihrem Docs-Repo, die URL eines gehosteten AsyncAPI-Schemadokuments oder ein Array mit Links zu AsyncAPI-Schemadokumenten enthalten. Mintlify generiert automatisch eine Seite für jeden AsyncAPI-Websocket-Kanal. Beispiele mit Tabs: 
"navigation": {
  "tabs": [
    {
        "tab": "API Reference",
        "asyncapi": "/path/to/asyncapi.json"
    }
  ]
}
Beispiele mit Gruppen: 
"navigation": {
  "tabs": [
    {
      "tab": "AsyncAPI",
      "groups": [
        {
          "group": "Websockets",
          "asyncapi": {
            "source": "/path/to/asyncapi.json",
            "directory": "api-reference"
          }
        }
      ]
    }
  ]
}
Das Feld directory ist optional. Wenn es nicht angegeben ist, werden die Dateien im Ordner api-reference des Docs-Repos abgelegt.

​
Kanalseite

Wenn du mehr Kontrolle darüber haben möchtest, wie du deine Kanäle sortierst, oder wenn du nur auf einen einzelnen Kanal verweisen willst, kannst du eine MDX-Datei mit dem Feld asyncapi im Frontmatter erstellen. 
---
title: "WebSocket-Kanal"
asyncapi: "/path/to/asyncapi.json channelName"
---