12 KiB
12 KiB
直播社交接口完整分析报告
生成时间: 2024年12月26日 分析范围: Android App 与 Zhibo-H 后端直播社交接口对比 说明: 本报告只分析直播社交相关接口,不包含电商接口
📊 总体概况
一、后端接口状态统计
| 分类 | 后端已实现 | 后端未实现 | App已对接 | App未对接 |
|---|---|---|---|---|
| 用户认证 | 6 | 0 | 2 | 4 |
| 用户资料 | 4 | 3 | 1 | 3 |
| 直播间 | 10 | 3 | 4 | 6 |
| 私聊消息 | 10 | 1 | 8 | 2 |
| 好友管理 | 6 | 0 | 6 | 0 |
| 礼物打赏 | 5 | 0 | 0 | 5 |
| 在线状态 | 7 | 0 | 0 | 7 |
| 离线消息 | 6 | 0 | 0 | 6 |
| 通话功能 | 10 | 0 | 0 | 10 |
| 文件上传 | 2 | 0 | 0 | 2 |
| 社交功能 | 0 | 8 | 0 | 0 |
| 通知推送 | 0 | 5 | 0 | 0 |
| 作品管理 | 0 | 6 | 0 | 0 |
| 搜索功能 | 0 | 4 | 0 | 0 |
二、关键数据
| 指标 | 数量 |
|---|---|
| 后端已实现接口 | 66 个 |
| 后端未实现接口 | 30 个 |
| App已对接接口 | 21 个 |
| App未对接(后端已有) | 45 个 |
| 后端完成度 | 69% |
| App对接完成度 | 32% |
✅ 第一部分:后端已实现 + App已对接(21个)
1. 用户认证 (2个)
| 接口 | 后端路径 | App调用位置 |
|---|---|---|
| 账号密码登录 | POST /api/front/login |
LoginActivity |
| 用户注册 | POST /api/front/register |
RegisterActivity |
2. 用户资料 (1个)
| 接口 | 后端路径 | App调用位置 |
|---|---|---|
| 获取用户信息 | GET /api/front/user/info |
ConversationActivity |
3. 直播间 (4个)
| 接口 | 后端路径 | App调用位置 |
|---|---|---|
| 获取直播间列表 | GET /api/front/live/public/rooms |
MainActivity |
| 获取直播间详情 | GET /api/front/live/public/rooms/{id} |
RoomDetailActivity |
| 创建直播间 | POST /api/front/live/rooms |
MainActivity |
| 删除直播间 | DELETE /api/front/live/rooms/{id} |
ApiService |
4. 私聊消息 (8个)
| 接口 | 后端路径 | App调用位置 |
|---|---|---|
| 获取会话列表 | GET /api/front/conversations |
MessagesActivity |
| 获取/创建会话 | POST /api/front/conversations/with/{userId} |
MyFriendsActivity |
| 标记会话已读 | POST /api/front/conversations/{id}/read |
ConversationActivity |
| 删除会话 | DELETE /api/front/conversations/{id} |
MessagesActivity |
| 获取消息列表 | GET /api/front/conversations/{id}/messages |
ConversationActivity |
| 发送私信 | POST /api/front/conversations/{id}/messages |
ConversationActivity |
| 删除消息 | DELETE /api/front/conversations/messages/{id} |
ConversationActivity |
| 撤回消息 | POST /api/front/conversations/messages/{id}/recall |
ConversationActivity |
5. 好友管理 (6个) ✅ 完全对接
| 接口 | 后端路径 | App调用位置 |
|---|---|---|
| 搜索用户 | GET /api/front/users/search |
AddFriendActivity |
| 发送好友请求 | POST /api/front/friends/request |
AddFriendActivity |
| 获取好友请求列表 | GET /api/front/friends/requests |
MyFriendsActivity |
| 处理好友请求 | POST /api/front/friends/requests/{id}/handle |
MyFriendsActivity |
| 获取好友列表 | GET /api/front/friends |
MyFriendsActivity |
| 删除好友 | DELETE /api/front/friends/{friendId} |
MyFriendsActivity |
⚠️ 第二部分:后端已实现 + App未对接(45个)
1. 用户认证 (4个)
| 接口 | 后端路径 | App需要修改 |
|---|---|---|
| 手机号登录 | POST /api/front/login/mobile |
LoginActivity |
| 发送验证码 | POST /api/front/sendCode |
RegisterActivity |
| 退出登录 | GET /api/front/logout |
SettingsPageActivity |
| Token校验 | POST /api/front/token/is/exist |
MainActivity |
2. 用户资料 (3个)
| 接口 | 后端路径 | App需要修改 |
|---|---|---|
| 获取用户中心 | GET /api/front/user |
ProfileActivity |
| 修改个人资料 | POST /api/front/user/edit |
EditProfileActivity |
| 修改密码 | POST /api/front/register/reset |
SettingsPageActivity |
3. 直播间 (6个)
| 接口 | 后端路径 | App需要修改 |
|---|---|---|
| 获取弹幕消息 | GET /api/front/live/public/rooms/{roomId}/messages |
RoomDetailActivity |
| 发送弹幕消息 | POST /api/front/live/public/rooms/{roomId}/messages |
RoomDetailActivity |
| 获取观看人数 | GET /api/front/live/public/rooms/{roomId}/viewers/count |
RoomDetailActivity |
| 关注/取消关注主播 | POST /api/front/live/follow |
RoomDetailActivity |
| SRS推流回调 | POST /api/front/live/srs/on_publish |
服务端回调 |
| SRS停流回调 | POST /api/front/live/srs/on_unpublish |
服务端回调 |
4. 私聊消息 (2个)
| 接口 | 后端路径 | App需要修改 |
|---|---|---|
| 搜索会话 | GET /api/front/conversations/search |
MessagesActivity |
| 获取消息详情 | GET /api/front/conversations/messages/{id} |
ConversationActivity |
5. 礼物打赏 (5个) ⚠️ 完全未对接
| 接口 | 后端路径 | App需要修改 |
|---|---|---|
| 获取礼物列表 | GET /api/front/gift/list |
RoomDetailActivity |
| 获取用户余额 | GET /api/front/gift/balance |
RoomDetailActivity |
| 赠送礼物 | POST /api/front/gift/send |
RoomDetailActivity |
| 获取充值选项 | GET /api/front/gift/recharge/options |
新建RechargeActivity |
| 创建充值订单 | POST /api/front/gift/recharge/create |
新建RechargeActivity |
6. 在线状态 (7个) ⚠️ 完全未对接
| 接口 | 后端路径 | App需要修改 |
|---|---|---|
| 检查用户在线 | GET /api/front/online/status/{userId} |
MyFriendsActivity |
| 批量检查在线 | POST /api/front/online/status/batch |
MyFriendsActivity |
| 获取房间在线用户 | GET /api/front/online/room/{roomId}/users |
RoomDetailActivity |
| 获取房间在线人数 | GET /api/front/online/room/{roomId}/count |
RoomDetailActivity |
| 获取离线消息数量 | GET /api/front/online/offline/count/{userId} |
MainActivity |
| 获取离线消息 | GET /api/front/online/offline/messages/{userId} |
MainActivity |
| 清除离线消息 | DELETE /api/front/online/offline/messages/{userId} |
MainActivity |
7. 离线消息 (6个) ⚠️ 完全未对接
| 接口 | 后端路径 | App需要修改 |
|---|---|---|
| 获取离线消息数量 | GET /api/front/offline-messages/count/{userId} |
MainActivity |
| 获取离线消息列表 | GET /api/front/offline-messages/list/{userId} |
MainActivity |
| 获取所有离线消息 | GET /api/front/offline-messages/all/{userId} |
MainActivity |
| 清除离线消息 | DELETE /api/front/offline-messages/clear/{userId} |
MainActivity |
| 删除指定数量 | DELETE /api/front/offline-messages/remove/{userId} |
MainActivity |
| 保存离线消息 | POST /api/front/offline-messages/save |
测试接口 |
8. 通话功能 (10个) ⚠️ 完全未对接(刚实现)
| 接口 | 后端路径 | App需要修改 |
|---|---|---|
| 发起通话 | POST /api/front/call/initiate |
新建CallActivity |
| 接听通话 | POST /api/front/call/accept/{callId} |
新建CallActivity |
| 拒绝通话 | POST /api/front/call/reject/{callId} |
新建CallActivity |
| 取消通话 | POST /api/front/call/cancel/{callId} |
新建CallActivity |
| 结束通话 | POST /api/front/call/end/{callId} |
新建CallActivity |
| 获取通话记录 | GET /api/front/call/history |
新建CallHistoryActivity |
| 删除通话记录 | DELETE /api/front/call/record/{recordId} |
新建CallHistoryActivity |
| 获取未接来电数 | GET /api/front/call/missed/count |
MainActivity |
| 获取通话状态 | GET /api/front/call/status |
新建CallActivity |
| 获取通话详情 | GET /api/front/call/detail/{callId} |
新建CallActivity |
9. 文件上传 (2个)
| 接口 | 后端路径 | App需要修改 |
|---|---|---|
| 图片上传 | POST /api/front/upload/image |
EditProfileActivity, ConversationActivity |
| 文件上传 | POST /api/front/upload/file |
ConversationActivity |
❌ 第三部分:后端未实现(30个)
1. 用户资料 (3个)
| 接口 | 期望路径 | 优先级 |
|---|---|---|
| 获取其他用户资料 | GET /api/front/user/profile/{userId} |
高 |
| 获取登录设备列表 | GET /api/front/user/devices |
低 |
| 注销账号 | POST /api/front/user/delete |
低 |
2. 直播间 (3个)
| 接口 | 期望路径 | 优先级 |
|---|---|---|
| 获取房间分类列表 | GET /api/front/live/categories |
中 |
| 获取关注主播直播间 | GET /api/front/live/following/rooms |
高 |
| 获取推荐直播间 | GET /api/front/live/recommend |
中 |
3. 私聊消息 (1个)
| 接口 | 期望路径 | 优先级 |
|---|---|---|
| 获取未读消息总数 | GET /api/front/messages/unread/count |
高 |
4. 社交功能 (8个) ⚠️ 重要
| 接口 | 期望路径 | 优先级 |
|---|---|---|
| 关注用户 | POST /api/front/follow/{userId} |
高 |
| 取消关注 | DELETE /api/front/follow/{userId} |
高 |
| 获取关注列表 | GET /api/front/following |
高 |
| 获取粉丝列表 | GET /api/front/fans |
高 |
| 获取获赞列表 | GET /api/front/likes |
中 |
| 获取附近用户 | GET /api/front/users/nearby |
中 |
| 检查关注状态 | GET /api/front/follow/status/{userId} |
高 |
| 获取社交数量 | GET /api/front/user/social/count |
高 |
5. 通知推送 (5个) ⚠️ 重要
| 接口 | 期望路径 | 优先级 |
|---|---|---|
| 获取通知列表 | GET /api/front/notifications |
高 |
| 标记通知已读 | POST /api/front/notifications/{id}/read |
高 |
| 标记全部已读 | POST /api/front/notifications/read/all |
中 |
| 获取通知设置 | GET /api/front/notifications/settings |
中 |
| 更新通知设置 | PUT /api/front/notifications/settings |
中 |
6. 作品管理 (6个)
| 接口 | 期望路径 | 优先级 |
|---|---|---|
| 发布作品 | POST /api/front/works |
高 |
| 获取作品列表 | GET /api/front/works |
高 |
| 获取作品详情 | GET /api/front/works/{id} |
高 |
| 删除作品 | DELETE /api/front/works/{id} |
中 |
| 点赞作品 | POST /api/front/works/{id}/like |
中 |
| 收藏作品 | POST /api/front/works/{id}/collect |
中 |
7. 搜索功能 (4个)
| 接口 | 期望路径 | 优先级 |
|---|---|---|
| 综合搜索 | GET /api/front/search |
高 |
| 搜索直播间 | GET /api/front/search/rooms |
中 |
| 搜索作品 | GET /api/front/search/works |
中 |
| 获取热门搜索 | GET /api/front/search/hot |
低 |
🎯 开发优先级建议
第一优先级:App对接已有接口(工作量小,见效快)
| 模块 | 接口数 | 预计工时 |
|---|---|---|
| 礼物打赏 | 5 | 2天 |
| 在线状态 | 7 | 1天 |
| 离线消息 | 6 | 1天 |
| 用户资料 | 3 | 1天 |
| 直播间弹幕 | 4 | 1天 |
| 文件上传 | 2 | 0.5天 |
| 小计 | 27 | 6.5天 |
第二优先级:后端开发新接口
| 模块 | 接口数 | 预计工时 |
|---|---|---|
| 社交功能 | 8 | 3-4天 |
| 通知推送 | 5 | 2-3天 |
| 作品管理 | 6 | 3-4天 |
| 搜索功能 | 4 | 2天 |
| 小计 | 23 | 10-13天 |
第三优先级:通话功能App对接
| 模块 | 接口数 | 预计工时 |
|---|---|---|
| 通话功能 | 10 | 5-7天 |
📊 总结
| 类型 | 数量 | 状态 |
|---|---|---|
| 后端已实现 + App已对接 | 21 | ✅ 已完成 |
| 后端已实现 + App未对接 | 45 | ⚠️ 需App开发 |
| 后端未实现 | 30 | ❌ 需后端+App开发 |
| 总计 | 96 |
总预计工时: 21-26 天
报告生成时间: 2024年12月26日