如何记录 websockets？
How to document websockets?
目前，我正在做一个使用 websockets 的项目，在我过去的项目中，我主要使用 RESTful 标准，使用 Postman 或 Swagger 很容易记录，但实际上我发现了问题，因为 Postman 和 Swagger 似乎不支持 WebSockets。
我的问题是您如何记录 WebSockets？任何信息都会有所帮助，但我主要是在寻找一些可以让我存储文档并与他人共享的工具。
我唯一找到的是 https://hoppscotch.io/
2022 年更新：Postman 引入了用于记录 API 的新工具，包括 websockets 和 grpc 完全解决了这个问题并提供了很好的工具来记录更多 API .
我一直在谷歌上搜索记录 WebSockets 的搜索解决方案，我的回答有点令人失望 - Postman、OpenAPI 或 RAML 不支持 WebSocket 文档。因此，记录使用 WebSockets 的软件部分的唯一合理方法是手动编写技术文档。
检查了 Slack 等大型组织的示例，他们使用相同的做法来记录 real-time 套接字，只是手写技术文档，我不知道该解决方案有多好，但基本上它会工作所以很好。
tl;dr 使用 AsyncAPI。
这里有一些学习资料：
- WebSocket, Shrek, and AsyncAPI - An Opinionated Intro
- Creating AsyncAPI for WebSocket API - Step by Step
- From API-First to Code Generation - A WebSocket Use Case
Async的官方例子API真实WebSocket的文档API：Gemini API. For preview in AsyncAPI Playground click here.
来自 EDASummit 的名为 An Opinionated Intro to AsyncAPI with WebSocket and Shrek and live stream 的 YouTube 演示文稿涵盖了上述前两篇文章。
目前，我正在做一个使用 websockets 的项目，在我过去的项目中，我主要使用 RESTful 标准，使用 Postman 或 Swagger 很容易记录，但实际上我发现了问题，因为 Postman 和 Swagger 似乎不支持 WebSockets。
我的问题是您如何记录 WebSockets？任何信息都会有所帮助，但我主要是在寻找一些可以让我存储文档并与他人共享的工具。
我唯一找到的是 https://hoppscotch.io/
2022 年更新：Postman 引入了用于记录 API 的新工具，包括 websockets 和 grpc 完全解决了这个问题并提供了很好的工具来记录更多 API .
我一直在谷歌上搜索记录 WebSockets 的搜索解决方案，我的回答有点令人失望 - Postman、OpenAPI 或 RAML 不支持 WebSocket 文档。因此，记录使用 WebSockets 的软件部分的唯一合理方法是手动编写技术文档。
检查了 Slack 等大型组织的示例，他们使用相同的做法来记录 real-time 套接字，只是手写技术文档，我不知道该解决方案有多好，但基本上它会工作所以很好。
tl;dr 使用 AsyncAPI。
这里有一些学习资料：
- WebSocket, Shrek, and AsyncAPI - An Opinionated Intro
- Creating AsyncAPI for WebSocket API - Step by Step
- From API-First to Code Generation - A WebSocket Use Case
Async的官方例子API真实WebSocket的文档API：Gemini API. For preview in AsyncAPI Playground click here.
来自 EDASummit 的名为 An Opinionated Intro to AsyncAPI with WebSocket and Shrek and live stream 的 YouTube 演示文稿涵盖了上述前两篇文章。