AsyncAPI のセットアップ

AsyncAPI で WebSocket のリファレンスページを作成する

AsyncAPI仕様ファイルを追加する

WebSocketのページ作成を始めるには、AsyncAPI仕様に準拠した有効なAsyncAPIスキーマ文書を、JSONまたはYAML形式で用意してください。スキーマはAsyncAPI 3.0以降の仕様に従っている必要があります。

AsyncAPIスキーマが有効かどうかは、 AsyncAPI Studio に貼り付けて検証できます

WebSocket ページを自動生成する

docs.json のナビゲーション内の任意のタブまたはグループに asyncapi フィールドを追加できます。このフィールドには、ドキュメントリポジトリ内の AsyncAPI スキーマドキュメントへのパス、ホストされた AsyncAPI スキーマドキュメントの URL、または複数の AsyncAPI スキーマドキュメントへのリンク配列を指定できます。Mintlify は、各 AsyncAPI の WebSocket チャンネルごとにページを自動生成します。

Tabs の例:

Local File

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

Groups の例:

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

directory フィールドは任意です。指定しない場合、ファイルはドキュメントリポジトリの api-reference フォルダーに配置されます。

チャンネルページ

チャンネルの並び順をより柔軟に制御したい場合や、特定のチャンネルだけを参照したい場合は、フロントマターに asyncapi フィールドを含む MDX ファイルを作成できます。

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