如何记录Websockets？

Question

5

目前，我正在处理一个项目，其中使用了websockets。在我的过去的项目中，我大多数时候都使用RESTful标准，这个标准很容易使用Postman或Swagger进行文档记录，但实际上我遇到了问题，因为Postman和Swagger似乎不支持WebSockets。

我的问题是，您如何记录WebSockets？任何信息都将有所帮助，但我最想找到一些工具，允许我存储文档并与他人共享。

2022年更新：Postman推出了新的工具，用于记录API，包括websockets和grpc，这确切地解决了这个问题，并提供了更好的工具来进一步记录API。

- keinsell

2个回答

0

我已经花了一些时间在谷歌上搜索WebSocket的文档解决方案，但我的答案有些令人失望 - Postman、OpenAPI或RAML都不支持WebSocket文档编写。因此，唯一合理的方法是手写技术文档来记录使用WebSockets的软件部分。

查看像Slack等大型组织的示例，他们使用相同的做法来记录实时套接字，只需手写技术文档即可。我不知道这个解决方案有多好，但基本上可以解决问题，所以没关系。

- keinsell

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Lukasz Gornicki · Accepted Answer

tl;dr 使用 AsyncAPI。

以下是一些学习材料：

官方示例 AsyncAPI 文档，适用于实际的 WebSocket API：Gemini API。在 AsyncAPI Playground 中预览，请点击此处。

EDASummit 的 YouTube 演示文稿：具有 WebSocket 和 Shrek 的 AsyncAPI 的主观介绍和涵盖上述前两篇文章的直播。