通过Swagger描述WebSocket API

xdyibdwo  于 2023-03-08  发布在  其他
关注(0)|答案(2)|浏览(780)

是否可以通过Swagger描述WebSocket服务器API?
我们有通过WebSocket服务器广播的事件,我想通过一个swagger规范文件来描述它们。
有没有websockets的文档生成器?

ozxc1zmp

ozxc1zmp1#

使用swagger-socket似乎是可能的。
尽管如此,目前似乎只存在Java/Scala服务器实现,这意味着它们没有“标准”Swagger REST服务那样多的codegens
编辑:正如所指出的,这个项目似乎已经死了。不幸的是,在更新这个答案的时候,似乎Swagger不是一个很好的Web套接字消息类型工具。

2ledvvac

2ledvvac2#

不是一个文档生成器,但它确实可以生成套接字文档
Firecamp-https://firecamp.io/类似于Postman,但也支持WebSocket和socketio连接,因此您可以在其中记录套接字连接,并将其导出到一个集合中,就像我们在Postman中使用API一样。

相关问题