通过Swagger描述websocket api

Question

是否可以通过 Swagger 描述 Websocket server api？

我们通过websocket服务器广播事件，我想通过一个swagger规范文件来描述它们。

是否有用于WebSocket的文档生成器？

Answer 1

不是一个文档生成器，但它确实可以对套接字进行文档编制

消防营地-https://firecamp.io/类似于邮递员，但也进行websocket和socketio连接。因此，您可以在那里记录套接字连接，并将其导出到集合中，就像我们在Postman中使用API一样。

Answer 2

使用swagger套接字似乎是可能的。

尽管如此，目前似乎只有Java / Scala服务器实现存在，这意味着它们不像“标准”Swagger REST服务那样多。

编辑：正如所指出的，这个项目似乎已经死了。不幸的是，在更新此答案时，Swagger似乎不是用于类型web套接字消息的好工具。