一、文档说明

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、聊天室绑定第三方独立域名

八、下载相关

1、Windows客户端下载

九、部署相关

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

扫描二维码阅读文章

架构说明

BBBUG音乐聊天室API端基于ThinkPHP6开发,在部署前你可能需要先了解一下ThinkPHP6的相关知识。

软件环境

  1. PHP7 (这里我们强烈建议你使用PHP7.1或7.2,避免使用其他版本带来其他的兼容问题)
  2. Nginx或Apache架构(我们以Nginx为例做部署说明)
  3. MySQL (我们建议使用MySQL5.6版本)
  4. Redis
  5. Composer (我们的依赖项都使用了Composer进行管理)

开始部署

  1. Clone我们开源仓库的代码到你服务器: git clone https://gitee.com/bbbug_com/ChatAPI.git
  2. 创建站点并指向public目录
  3. ThinkPHP官方说明配置伪静态
  4. Database.sql导入到你自己的数据库,并修改conf表中的部分配置
  5. 复制.example.env.env并修改你自己的数据库
  6. 如果你的Redis服务器不在本机,你可能还需要修改一下config/cache.php文件里的Redis连接信息
  7. 再站点根目录下执行composer install安装必要的依赖文件

不出意外,到这里如果直接访问http://your-domain.com/会跳转到BBBUG.COM官网聊天室,访问http://your-domain.com/api会输出Hello World的JSON数据。

因为前后端完全分离,这里你需要配置一下允许你的前端跨域访问API,具体可查看Nginx或Apache的允许跨域配置

到此,API端基本部署完成,接下来我们配置一下歌曲爬虫和歌曲同步部分:

  1. 歌曲同步部分 php think Song
  2. 死链歌曲下载部分 php think Download

当然,这里我们强烈推荐使用Supervisor对上面两个进程进行守护,鬼知道PHP什么时候又挂掉了。

与Websocket服务数据交互部分

当前版本的websocket与API服务是松耦合的设计(作者的遗留问题,之前的websocket服务是公有服务),所以这里需要配置一下Websocket的连接信息

修改conf表中的IP和端口地址为你部署的websocket服务地址。

Websocket服务的部署手册请点击我查看

结语

到这里基本完成了API端的所有配置,接下来去部署其他端吧~