有没有一个推荐的方式,良好的做法,以文件的websockets?

我正在编写一个严重依赖于socket.io的应用程序。 我想提供由我的服务器处理的事件的文档,以帮助开发其前端部分。

我知道如何文档的HTTP API端点(例如与大招),但不知道如何正确使用socket.io / websockets做到这一点。

我有websocket房间的forms: – 'player /' – 'land /'

我有像这样的事件:

socket.on('land/join', (landId) => { socket.emit('land/join success') }) 

当然,有时候,而不是普通的套接字,我只是将事件发送到给定的房间,就像上面一样,还有两件事情发生:

 socket.join('land/<id>') io.to('land/<id>').emit('new message', message) 

我想logging以上所有内容。 客户端和服务器端事件及其参数。