Documenting Phoenix Channels

Phoenix Forum Questions / Help
, ,
1

Hey!
Are there any tools for writing documentation Websocket API for Phoenix channels?

2

:wave:

I know of GitHub - api-hogs/bureaucrat: Generate Phoenix API documentation from tests.

1 Like
3

Thank u! It looks good, but there are only 3 testing helpers:

  • doc_push
  • doc_broadcast_from
  • doc_broadcast_from!

Actually I’d like to document the socket connection, channels joining and replies…

4

You can document the replies like this:

assert_push("msg", payload) |> doc(description: "description of the channel reply")
1 Like