Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
使用 AsyncAPI 规范创建 WebSocket 文档。
/your-project
|- docs.json
|- asyncapi.json
asyncapi 属性。asyncapi 接受文档仓库中 AsyncAPI 架构文件的路径、托管的 AsyncAPI 文档的 URL，或指向 AsyncAPI 架构文档的链接数组。
"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"
]
}
]
}
"navigation": {
"tabs": [
{
"tab": "AsyncAPI",
"groups": [
{
"group": "Websockets",
"asyncapi": {
"source": "/path/to/asyncapi.json",
"directory": "websockets"
}
}
]
}
]
}
directory 字段为可选。若未指定，文件将放置在文档仓库的 api-reference 文件夹中。asyncapi 属性的 MDX 文件。
---
title: "WebSocket 频道"
asyncapi: "/path/to/asyncapi.json channelName"
---