一、文档说明

1、写在前面2、错误代码表

二、用户接口

1、发送邮箱验证码接口2、用户登录接口3、获取我的个人信息接口4、修改我的资料接口5、临时用户相关说明6、获取指定用户个人资料接口7、禁言用户接口8、禁止用户点歌接口9、取消用户的禁言和禁歌10、摸一摸用户接口11、第三方登录接口

三、房间接口

1、获取热门房间接口2、获取房间详情接口3、获取房间在线人员列表4、修改房间信息接口5、获取指定房间当前正在播放音乐接口6、获取聊天室指定房间的历史记录7、撤回消息接口

四、歌曲接口

1、歌曲搜索接口2、获取LRC歌词接口3、歌曲播放地址跳转地址4、管理员或房主切歌接口5、用户点歌接口6、指定房间当前的已点歌曲列表7、将已点歌曲列表中指定歌曲置顶8、管理或房主移除已点歌曲接口9、获取我点过的歌列表接口10、从我的歌单删除歌曲接口

五、Websocket

1、获取Websocket连接地址2、发送文字消息接口3、发送图片消息接口4、WebSocket消息解析说明文档

六、图片接口

1、搜索图片表情包2、上传图片接口

七、第三方合作接口

1、第三方接入聊天室使用手册与帮助文档2、聊天室绑定第三方独立域名3、SVG外链和iFrame播放器外链使用说明4、合作网站

八、下载相关

1、Windows客户端下载

九、部署相关

0、写在最前面1、部署API端步骤说明2、部署Websocket服务端步骤3、部署最后的前端部分
2、部署Websocket服务端步骤
手机阅读

扫描二维码阅读文章

架构说明

老样子,因为作者的历史遗留问题,Websocket服务需要单独部署。Websocket服务基于NodeJS,你这里需要安装NodeJS(顺带会安装npm包管理器)。

部署步骤

  1. 首先编辑websocket.js文件,将其中的API请求部分地址https://api.bbbug.com修改为你部署API端的域名地址
  2. 安装NodeJS,并执行node websocket.js,如果报错,请安装报错中提示的模块,比如npm install nodejs-websocket
  3. 如果你存在端口占用的问题,那么请记得修改一下端口号,同时变更一下API端部署时与Websocket的连接信息部分
  4. 我们推荐你使用Nginx对这个Websocket服务进行反代,顺便实现一下基于TLS安全层的WSS服务。
  5. 到此原则上Websocket已经部署成功,但我们建议你使用PM2对这个进程进行守护,鬼知道这个服务什么时候也会跟PHP一样炸掉呢。

结语

到这里Websocket服务就跑起来了,如果你有疑问或者问题,可以去BBBUG.COM官方聊天室找ID:10000协助解决。