生成 WebSocket 参考文档 | Fern Documentation

Fern 从 AsyncAPI 规范或 Fern Definition 生成 WebSocket 参考文档。

配置

对于 AsyncAPI：将规范文件添加到 /fern 目录中，并创建一个引用它的 generators.yml：

generators.yml

1 api:
2   path: asyncapi.yml
3   origin: https://github.com/your-org/your-repo/blob/main/asyncapi.yml # 可选

对于 Fern Definition：将 WebSocket 定义文件添加到 definition/ 目录中（Fern 会自动检测）。

在 docs.yml 的导航中添加 - api: API Reference：

docs.yml

1 navigation:
2   - api: API Reference

有关配置选项和布局自定义的完整列表，请参阅自定义 API 参考文档布局。

要在文档中包含多个 WebSocket 定义，请使用 api-name 属性。api-name 对应包含 WebSocket 定义的文件夹名称。

fern

fern.config.json

docs.yml

streaming-api

asyncapi.yml# 流式 WebSocket AsyncAPI 规范

generators.yml

realtime-api

asyncapi.yml# 实时 WebSocket AsyncAPI 规范

generators.yml

docs.yml

1 navigation:
2   - api: Streaming API
3     api-name: streaming-api
4   - api: Realtime API
5     api-name: realtime-api