问题描述
当前，我正在使用websockets的项目中工作，而在过去的项目中，我主要使用RESTful标准，而该标准很容易使用Postman或Swagger进行文档记录，但实际上我发现了问题，因为Postman和Swagger似乎不支持WebSockets。
我的问题是您如何记录WebSockets？任何信息都将有所帮助，但我主要是在寻找一些工具，使我可以存储文档并与他人共享。
我唯一发现的是https://hoppscotch.io/
解决方法
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
真实 WebSocket API 的 AsyncAPI 文档官方示例：Gemini API。在 AsyncAPI Playground click here 中预览。
来自 EDASummit 的名为 An Opinionated Intro to AsyncAPI with WebSocket and Shrek 和 live stream 的 YouTube 演示文稿，涵盖了上述前两篇文章。
,我一直在寻找用于记录WebSockets的搜索解决方案一段时间，我的回答有点令人失望-邮递员，OpenAPI或RAML不支持WebSocket文档。因此，记录使用WebSockets的软件部分的唯一合理方法是手工编写技术文档。
在较大的组织（如Slack等）上检查了示例，它们使用相同的做法来记录实时套接字，只是手工编写技术文档，我不知道该解决方案有多好，但基本上它会起作用很好。