在 Aiohttp/Python 中记录 websocket 消息的最佳方式是什么?

What is the best way to document websocket messages in Aiohttp/Python?

我使用 aiohttp-swagger 创建我的 http 端点的有用文档,但我也有 websocket,它可以 send/receive 几种类型的消息(所有 json 用于项目),什么是记录这些消息的最佳方式吗?

AsyncAPI 是 WebSockets 的 OpenAPI 规范(fka Swagger 规范)的类比。

截至 2021 年 11 月,有 Asynction and Python AsyncAPI 个项目允许您在 Python 中使用 AsyncAPI。

您还可以手动为您的 WebSocket 消息编写 AsyncAPI 定义(YAML 或 JSON 文件)并使用 doc renderers.

之一显示此文档