How to document a socket-based API?

Anyone have a pattern that they’re especially happy with for documenting a Phoenix Channels-based API?

I’m looking for something akin to, but for socket APIs, not HTTP.


This is also an area I am really interested in. Is there a standard way of documenting Websocket api’s? For HTTP we can choose Swagger, Api Blueprint or other alternatives but for Websockets this is not clear to me. Already found something sinds october?

Bureaucrat has some support for documenting Phoenix channels in markdown.

You could run that through a static site generator to produce docs.