Describe websocket api via Swagger

websocket swagger
Somebody picture Somebody · Jul 4, 2016 · Viewed 16.2k times · Source

Is it possible to describe Websocket server api via Swagger?

We have events broadcasting via websocket server and i want to describe them via one swagger specification file.

Is there any documentation generators for websockets?

Answer

Benjamin Soulier picture Benjamin Soulier · Sep 5, 2016

It seems to be possible using swagger-socket.

Still, it seems that only a Java/Scala server implementation exists for now, which means they are not as much codegens for this that there is for "standard" Swagger REST services.

Related questions

How to document websocket events or callback in swagger

I have a setup where it is possible to get some resource using standard REST and this is easy documented in swagger. The same resource is pushed to clients using websockets when it has changed, so clients does not have …

Read More
Send message to specific client with socket.io and node.js

I'm working with socket.io and node.js and until now it seems pretty good, but I don't know how to send a message from the server to an specific client, something like this: client.send(message, receiverSessionId) But neither …

Read More
Which websocket library to use with Node.js?

Currently there is a plethora of websocket libraries for node.js, the most popular seem to be: https://github.com/Worlize/WebSocket-Node https://github.com/einaros/ws https://github.com/LearnBoost/engine.io https://github.com/learnboost/socket.io https://…

Read More