通过 Swagger 描述 websocket api

【问题标题】：Describe websocket api via Swagger通过 Swagger 描述 websocket api
【发布时间】：2016-11-06 06:57:51
【问题描述】：

是否可以通过 Swagger 描述 Websocket 服务器 api？

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

是否有任何用于 websockets 的文档生成器？

【问题讨论】：

【解决方案1】：

似乎可以使用swagger-socket。

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

【讨论】：

【解决方案2】：

不是文档生成器，但这确实会记录套接字

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

【讨论】：