下载 AsyncAPI 规范

Fern 文档站点自动提供您的原始 AsyncAPI 2.6.0 规范用于 WebSocket 通道，因此任何人——或任何工具——都可以下载它用于客户端生成、合约测试或导入到支持 AsyncAPI 的工具中。

该规范也从您站点的 llms.txt 中进行链接，因此像 Cursor、Copilot 和 Claude 这样的 AI 编码助手可以发现并使用它来生成准确的 WebSocket 集成。

可用端点

每个带有 WebSocket 通道的 Fern 文档站点都会在这些路径公开 AsyncAPI 规范：

该规范包括所有 WebSocket 通道，包含发布/订阅消息、路径参数、查询参数、作为 WebSocket 绑定的头部、身份验证方案、作为组件架构的类型定义，以及来自您环境配置的服务器 URL。它从驱动您文档的同一个 API 定义生成，因此始终保持最新。

使用方法

将端点附加到您的文档 URL 来下载规范：

$
# 下载为 JSON
$
curl https://your-docs-site.com/asyncapi.json
$
$
# 下载为 YAML
$
curl https://your-docs-site.com/asyncapi.yaml

如果您的文档站点包含多个带有 WebSocket 通道的 API 定义，端点会返回可用 API 的列表。使用 api 查询参数来选择特定的 API：

$
# 获取特定 API 的规范
$
curl https://your-docs-site.com/asyncapi.json?api=my-api-id