添加Log文档目录:后端接口分析报告
This commit is contained in:
parent
827ef40900
commit
ecaed42912
3
.gitignore
vendored
3
.gitignore
vendored
|
|
@ -21,6 +21,9 @@ yarn-error.log*
|
||||||
**/log/
|
**/log/
|
||||||
**/*_log/
|
**/*_log/
|
||||||
|
|
||||||
|
# 排除项目文档目录
|
||||||
|
!Log/
|
||||||
|
|
||||||
# build output
|
# build output
|
||||||
build/
|
build/
|
||||||
dist/
|
dist/
|
||||||
|
|
|
||||||
318
Log/系统/IM-gift分支接口分析报告.md
Normal file
318
Log/系统/IM-gift分支接口分析报告.md
Normal file
|
|
@ -0,0 +1,318 @@
|
||||||
|
# IM-gift 分支接口分析报告
|
||||||
|
|
||||||
|
> **生成时间**: 2024年12月26日
|
||||||
|
> **分支**: IM-gift
|
||||||
|
> **分析范围**: 直播社交相关接口(不含电商)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📊 总体概况
|
||||||
|
|
||||||
|
### IM-gift分支新增的模块
|
||||||
|
相比master分支,IM-gift分支新增了以下Controller:
|
||||||
|
- `GroupController` - 群组管理 ✅ 新增
|
||||||
|
- `GroupMessageController` - 群组消息 ✅ 新增
|
||||||
|
- `MessageForwardController` - 消息转发 ✅ 新增
|
||||||
|
- `MessageReactionController` - 消息表情回应 ✅ 新增
|
||||||
|
- `MessageRecallController` - 消息撤回 ✅ 新增
|
||||||
|
- `MessageSearchController` - 消息搜索 ✅ 新增
|
||||||
|
- `CategoryController` - 分类管理 ✅ 新增
|
||||||
|
|
||||||
|
### 后端接口状态统计
|
||||||
|
|
||||||
|
| 分类 | 后端已实现 | 后端未实现 | App已对接 | App未对接 |
|
||||||
|
|------|-----------|-----------|----------|----------|
|
||||||
|
| 用户认证 | 6 | 0 | 2 | 4 |
|
||||||
|
| 用户资料 | 4 | 3 | 1 | 3 |
|
||||||
|
| 直播间 | 10 | 0 | 4 | 6 |
|
||||||
|
| 私聊消息 | 10 | 0 | 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 |
|
||||||
|
| **群组管理** | **15** | 0 | 0 | **15** |
|
||||||
|
| **群组消息** | **4** | 0 | 0 | **4** |
|
||||||
|
| **消息转发** | **5** | 0 | 0 | **5** |
|
||||||
|
| **消息表情回应** | **7** | 0 | 0 | **7** |
|
||||||
|
| **消息撤回** | **3** | 0 | 0 | **3** |
|
||||||
|
| **消息搜索** | **6** | 0 | 0 | **6** |
|
||||||
|
| **分类管理** | **4** | 0 | 0 | **4** |
|
||||||
|
| 社交功能 | 0 | 8 | 0 | 0 |
|
||||||
|
| 通知推送 | 0 | 5 | 0 | 0 |
|
||||||
|
| 作品管理 | 0 | 6 | 0 | 0 |
|
||||||
|
|
||||||
|
### 关键数据
|
||||||
|
|
||||||
|
| 指标 | 数量 |
|
||||||
|
|------|------|
|
||||||
|
| **后端已实现接口** | 110 个 |
|
||||||
|
| **后端未实现接口** | 22 个 |
|
||||||
|
| **App已对接接口** | 21 个 |
|
||||||
|
| **App未对接(后端已有)** | 89 个 |
|
||||||
|
| **后端完成度** | 83% |
|
||||||
|
| **App对接完成度** | 19% |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## ✅ 第一部分:后端已实现 + App已对接(21个)
|
||||||
|
|
||||||
|
### 1. 用户认证 (2个)
|
||||||
|
| 接口 | 后端路径 |
|
||||||
|
|------|----------|
|
||||||
|
| 账号密码登录 | `POST /api/front/login` |
|
||||||
|
| 用户注册 | `POST /api/front/register` |
|
||||||
|
|
||||||
|
### 2. 直播间 (4个)
|
||||||
|
| 接口 | 后端路径 |
|
||||||
|
|------|----------|
|
||||||
|
| 获取直播间列表 | `GET /api/front/live/public/rooms` |
|
||||||
|
| 获取直播间详情 | `GET /api/front/live/public/rooms/{id}` |
|
||||||
|
| 创建直播间 | `POST /api/front/live/rooms` |
|
||||||
|
| 删除直播间 | `DELETE /api/front/live/rooms/{id}` |
|
||||||
|
|
||||||
|
### 3. 私聊消息 (8个)
|
||||||
|
| 接口 | 后端路径 |
|
||||||
|
|------|----------|
|
||||||
|
| 获取会话列表 | `GET /api/front/conversations` |
|
||||||
|
| 获取/创建会话 | `POST /api/front/conversations/with/{userId}` |
|
||||||
|
| 标记会话已读 | `POST /api/front/conversations/{id}/read` |
|
||||||
|
| 删除会话 | `DELETE /api/front/conversations/{id}` |
|
||||||
|
| 获取消息列表 | `GET /api/front/conversations/{id}/messages` |
|
||||||
|
| 发送私信 | `POST /api/front/conversations/{id}/messages` |
|
||||||
|
| 删除消息 | `DELETE /api/front/conversations/messages/{id}` |
|
||||||
|
| 撤回消息 | `POST /api/front/conversations/messages/{id}/recall` |
|
||||||
|
|
||||||
|
### 4. 好友管理 (6个) ✅ 完全对接
|
||||||
|
| 接口 | 后端路径 |
|
||||||
|
|------|----------|
|
||||||
|
| 搜索用户 | `GET /api/front/users/search` |
|
||||||
|
| 发送好友请求 | `POST /api/front/friends/request` |
|
||||||
|
| 获取好友请求列表 | `GET /api/front/friends/requests` |
|
||||||
|
| 处理好友请求 | `POST /api/front/friends/requests/{id}/handle` |
|
||||||
|
| 获取好友列表 | `GET /api/front/friends` |
|
||||||
|
| 删除好友 | `DELETE /api/front/friends/{friendId}` |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## ⚠️ 第二部分:后端已实现 + App未对接(89个)
|
||||||
|
|
||||||
|
### 1. 群组管理 (15个) ⚠️ 全新模块
|
||||||
|
| 接口 | 后端路径 | 说明 |
|
||||||
|
|------|----------|------|
|
||||||
|
| 创建群组 | `POST /api/front/groups/create` | 新建群聊 |
|
||||||
|
| 更新群组信息 | `PUT /api/front/groups/{groupId}` | 修改群名等 |
|
||||||
|
| 解散群组 | `DELETE /api/front/groups/{groupId}` | 群主解散 |
|
||||||
|
| 获取群组列表 | `GET /api/front/groups/list` | 我的群组 |
|
||||||
|
| 获取群组详情 | `GET /api/front/groups/{groupId}` | 群详情 |
|
||||||
|
| 更新群公告 | `PUT /api/front/groups/{groupId}/announcement` | 群公告 |
|
||||||
|
| 设置全员禁言 | `PUT /api/front/groups/{groupId}/mute-all` | 禁言 |
|
||||||
|
| 邀请成员 | `POST /api/front/groups/{groupId}/members/invite` | 邀请入群 |
|
||||||
|
| 移除成员 | `DELETE /api/front/groups/{groupId}/members/{userId}` | 踢人 |
|
||||||
|
| 退出群组 | `POST /api/front/groups/{groupId}/quit` | 退群 |
|
||||||
|
| 获取成员列表 | `GET /api/front/groups/{groupId}/members` | 群成员 |
|
||||||
|
| 设置管理员 | `PUT /api/front/groups/{groupId}/members/{userId}/admin` | 设管理 |
|
||||||
|
| 禁言成员 | `PUT /api/front/groups/{groupId}/members/{userId}/mute` | 禁言 |
|
||||||
|
| 取消禁言 | `PUT /api/front/groups/{groupId}/members/{userId}/unmute` | 解禁 |
|
||||||
|
| 更新群昵称 | `PUT /api/front/groups/{groupId}/members/nickname` | 群昵称 |
|
||||||
|
|
||||||
|
### 2. 群组消息 (4个) ⚠️ 全新模块
|
||||||
|
| 接口 | 后端路径 | 说明 |
|
||||||
|
|------|----------|------|
|
||||||
|
| 发送群组消息 | `POST /api/front/groups/{groupId}/messages` | 发消息 |
|
||||||
|
| 获取群组消息列表 | `GET /api/front/groups/{groupId}/messages` | 消息列表 |
|
||||||
|
| 撤回群组消息 | `POST /api/front/groups/messages/{messageId}/recall` | 撤回 |
|
||||||
|
| 删除群组消息 | `DELETE /api/front/groups/messages/{messageId}` | 删除 |
|
||||||
|
|
||||||
|
### 3. 消息转发 (5个) ⚠️ 全新模块
|
||||||
|
| 接口 | 后端路径 | 说明 |
|
||||||
|
|------|----------|------|
|
||||||
|
| 转发给好友 | `POST /api/front/messages/forward/friend` | 转发私聊 |
|
||||||
|
| 转发到群组 | `POST /api/front/messages/forward/group` | 转发群聊 |
|
||||||
|
| 批量转发 | `POST /api/front/messages/forward/batch` | 多选转发 |
|
||||||
|
| 获取转发历史 | `GET /api/front/messages/forward/history` | 转发记录 |
|
||||||
|
| 删除转发记录 | `DELETE /api/front/messages/forward/{forwardId}` | 删除记录 |
|
||||||
|
|
||||||
|
### 4. 消息表情回应 (7个) ⚠️ 全新模块
|
||||||
|
| 接口 | 后端路径 | 说明 |
|
||||||
|
|------|----------|------|
|
||||||
|
| 添加表情回应 | `POST /api/front/messages/reactions/add` | 点赞等 |
|
||||||
|
| 取消表情回应 | `DELETE /api/front/messages/reactions/remove` | 取消 |
|
||||||
|
| 获取回应列表 | `GET /api/front/messages/reactions/list` | 回应列表 |
|
||||||
|
| 获取回应统计 | `GET /api/front/messages/reactions/statistics` | 统计 |
|
||||||
|
| 获取回应用户 | `GET /api/front/messages/reactions/users` | 谁点赞 |
|
||||||
|
| 检查回应状态 | `GET /api/front/messages/reactions/check` | 是否已赞 |
|
||||||
|
| 切换表情回应 | `POST /api/front/messages/reactions/toggle` | 切换 |
|
||||||
|
|
||||||
|
### 5. 消息撤回 (3个) ⚠️ 全新模块
|
||||||
|
| 接口 | 后端路径 | 说明 |
|
||||||
|
|------|----------|------|
|
||||||
|
| 撤回私聊消息 | `POST /api/front/messages/private/{messageId}/recall` | 私聊撤回 |
|
||||||
|
| 撤回群组消息 | `POST /api/front/messages/group/{messageId}/recall` | 群聊撤回 |
|
||||||
|
| 检查是否可撤回 | `GET /api/front/messages/{messageId}/can-recall` | 检查 |
|
||||||
|
|
||||||
|
### 6. 消息搜索 (6个) ⚠️ 全新模块
|
||||||
|
| 接口 | 后端路径 | 说明 |
|
||||||
|
|------|----------|------|
|
||||||
|
| 搜索私聊消息 | `GET /api/front/messages/search/private` | 搜私聊 |
|
||||||
|
| 搜索群组消息 | `GET /api/front/messages/search/group` | 搜群聊 |
|
||||||
|
| 在会话中搜索 | `GET /api/front/messages/search/conversation/{id}` | 会话内搜 |
|
||||||
|
| 在群组中搜索 | `GET /api/front/messages/search/group/{id}` | 群内搜 |
|
||||||
|
| 获取搜索历史 | `GET /api/front/messages/search/history` | 搜索历史 |
|
||||||
|
| 清除搜索历史 | `DELETE /api/front/messages/search/history` | 清除 |
|
||||||
|
|
||||||
|
### 7. 分类管理 (4个) ⚠️ 全新模块
|
||||||
|
| 接口 | 后端路径 | 说明 |
|
||||||
|
|------|----------|------|
|
||||||
|
| 获取直播间分类 | `GET /api/front/category/live-room` | 直播分类 |
|
||||||
|
| 获取作品分类 | `GET /api/front/category/work` | 作品分类 |
|
||||||
|
| 获取指定类型分类 | `GET /api/front/category/list` | 通用分类 |
|
||||||
|
| 获取分类详情 | `GET /api/front/category/{id}` | 分类详情 |
|
||||||
|
|
||||||
|
### 8. 礼物打赏 (5个)
|
||||||
|
| 接口 | 后端路径 |
|
||||||
|
|------|----------|
|
||||||
|
| 获取礼物列表 | `GET /api/front/gift/list` |
|
||||||
|
| 获取用户余额 | `GET /api/front/gift/balance` |
|
||||||
|
| 赠送礼物 | `POST /api/front/gift/send` |
|
||||||
|
| 获取充值选项 | `GET /api/front/gift/recharge/options` |
|
||||||
|
| 创建充值订单 | `POST /api/front/gift/recharge/create` |
|
||||||
|
|
||||||
|
### 9. 在线状态 (7个)
|
||||||
|
| 接口 | 后端路径 |
|
||||||
|
|------|----------|
|
||||||
|
| 检查用户在线 | `GET /api/front/online/status/{userId}` |
|
||||||
|
| 批量检查在线 | `POST /api/front/online/status/batch` |
|
||||||
|
| 获取房间在线用户 | `GET /api/front/online/room/{roomId}/users` |
|
||||||
|
| 获取房间在线人数 | `GET /api/front/online/room/{roomId}/count` |
|
||||||
|
| 获取离线消息数量 | `GET /api/front/online/offline/count/{userId}` |
|
||||||
|
| 获取离线消息 | `GET /api/front/online/offline/messages/{userId}` |
|
||||||
|
| 清除离线消息 | `DELETE /api/front/online/offline/messages/{userId}` |
|
||||||
|
|
||||||
|
### 10. 通话功能 (10个)
|
||||||
|
| 接口 | 后端路径 |
|
||||||
|
|------|----------|
|
||||||
|
| 发起通话 | `POST /api/front/call/initiate` |
|
||||||
|
| 接听通话 | `POST /api/front/call/accept/{callId}` |
|
||||||
|
| 拒绝通话 | `POST /api/front/call/reject/{callId}` |
|
||||||
|
| 取消通话 | `POST /api/front/call/cancel/{callId}` |
|
||||||
|
| 结束通话 | `POST /api/front/call/end/{callId}` |
|
||||||
|
| 获取通话记录 | `GET /api/front/call/history` |
|
||||||
|
| 删除通话记录 | `DELETE /api/front/call/record/{recordId}` |
|
||||||
|
| 获取未接来电数 | `GET /api/front/call/missed/count` |
|
||||||
|
| 获取通话状态 | `GET /api/front/call/status` |
|
||||||
|
| 获取通话详情 | `GET /api/front/call/detail/{callId}` |
|
||||||
|
|
||||||
|
### 11. 其他已有接口
|
||||||
|
- 用户认证 (4个未对接)
|
||||||
|
- 用户资料 (3个未对接)
|
||||||
|
- 直播间 (6个未对接)
|
||||||
|
- 私聊消息 (2个未对接)
|
||||||
|
- 文件上传 (2个未对接)
|
||||||
|
- 离线消息 (6个未对接)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## ❌ 第三部分:后端未实现(22个)
|
||||||
|
|
||||||
|
### 1. 用户资料 (3个)
|
||||||
|
| 接口 | 期望路径 | 优先级 |
|
||||||
|
|------|----------|--------|
|
||||||
|
| 获取其他用户资料 | `GET /api/front/user/profile/{userId}` | 高 |
|
||||||
|
| 获取登录设备列表 | `GET /api/front/user/devices` | 低 |
|
||||||
|
| 注销账号 | `POST /api/front/user/delete` | 低 |
|
||||||
|
|
||||||
|
### 2. 社交功能 (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` | 高 |
|
||||||
|
|
||||||
|
### 3. 通知推送 (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` | 中 |
|
||||||
|
|
||||||
|
### 4. 作品管理 (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` | 中 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🎯 开发优先级建议
|
||||||
|
|
||||||
|
### 第一优先级:App对接已有接口(工作量最小)
|
||||||
|
|
||||||
|
| 模块 | 接口数 | 预计工时 | 说明 |
|
||||||
|
|------|--------|----------|------|
|
||||||
|
| 群组管理 | 15 | 3-4天 | 全新功能,需新建Activity |
|
||||||
|
| 群组消息 | 4 | 2天 | 群聊页面 |
|
||||||
|
| 消息转发 | 5 | 1天 | 长按消息菜单 |
|
||||||
|
| 消息表情回应 | 7 | 1天 | 消息点赞 |
|
||||||
|
| 消息搜索 | 6 | 1天 | 搜索功能 |
|
||||||
|
| 礼物打赏 | 5 | 2天 | 直播间礼物 |
|
||||||
|
| 在线状态 | 7 | 1天 | 好友在线 |
|
||||||
|
| 分类管理 | 4 | 0.5天 | 分类筛选 |
|
||||||
|
| **小计** | **53** | **11-12天** | |
|
||||||
|
|
||||||
|
### 第二优先级:后端开发新接口
|
||||||
|
|
||||||
|
| 模块 | 接口数 | 预计工时 |
|
||||||
|
|------|--------|----------|
|
||||||
|
| 社交功能 | 8 | 3-4天 |
|
||||||
|
| 通知推送 | 5 | 2-3天 |
|
||||||
|
| 作品管理 | 6 | 3-4天 |
|
||||||
|
| **小计** | **19** | **8-11天** |
|
||||||
|
|
||||||
|
### 第三优先级:通话功能App对接
|
||||||
|
|
||||||
|
| 模块 | 接口数 | 预计工时 |
|
||||||
|
|------|--------|----------|
|
||||||
|
| 通话功能 | 10 | 5-7天 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📊 总结
|
||||||
|
|
||||||
|
| 类型 | 数量 | 状态 |
|
||||||
|
|------|------|------|
|
||||||
|
| 后端已实现 + App已对接 | 21 | ✅ 已完成 |
|
||||||
|
| 后端已实现 + App未对接 | 89 | ⚠️ 需App开发 |
|
||||||
|
| 后端未实现 | 22 | ❌ 需后端+App开发 |
|
||||||
|
| **总计** | **132** | |
|
||||||
|
|
||||||
|
### IM-gift分支相比master的优势
|
||||||
|
- ✅ 群组聊天功能完整实现(19个接口)
|
||||||
|
- ✅ 消息转发功能完整实现(5个接口)
|
||||||
|
- ✅ 消息表情回应功能完整实现(7个接口)
|
||||||
|
- ✅ 消息撤回功能完整实现(3个接口)
|
||||||
|
- ✅ 消息搜索功能完整实现(6个接口)
|
||||||
|
- ✅ 分类管理功能完整实现(4个接口)
|
||||||
|
|
||||||
|
### 仍需开发的功能
|
||||||
|
- ❌ 社交功能(关注/粉丝)
|
||||||
|
- ❌ 通知推送
|
||||||
|
- ❌ 作品管理
|
||||||
|
|
||||||
|
**总预计工时**: 24-30 天
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**报告生成时间**: 2024年12月26日
|
||||||
290
Log/系统/后端接口完整清单.md
Normal file
290
Log/系统/后端接口完整清单.md
Normal file
|
|
@ -0,0 +1,290 @@
|
||||||
|
# Zhibo-H 后端接口完整清单
|
||||||
|
|
||||||
|
> 生成时间: 2024-12-26
|
||||||
|
> 分支: IM-gift
|
||||||
|
|
||||||
|
## 一、接口统计概览
|
||||||
|
|
||||||
|
| 模块 | 接口数量 | App已对接 | 待对接 |
|
||||||
|
|------|---------|----------|--------|
|
||||||
|
| 用户认证 | 7 | 2 | 5 |
|
||||||
|
| 直播间 | 11 | 5 | 6 |
|
||||||
|
| 私聊会话 | 7 | 0 | 7 |
|
||||||
|
| 好友管理 | 8 | 0 | 8 |
|
||||||
|
| 群组管理 | 15 | 0 | 15 |
|
||||||
|
| 群组消息 | 4 | 0 | 4 |
|
||||||
|
| 礼物打赏 | 5 | 0 | 5 |
|
||||||
|
| 消息转发 | 5 | 0 | 5 |
|
||||||
|
| 消息表情 | 7 | 0 | 7 |
|
||||||
|
| 消息撤回 | 3 | 0 | 3 |
|
||||||
|
| 消息搜索 | 6 | 0 | 6 |
|
||||||
|
| 通话功能 | 8 | 0 | 8 |
|
||||||
|
| 用户中心 | 20+ | 0 | 20+ |
|
||||||
|
| **总计** | **~106** | **7** | **~99** |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 二、详细接口清单
|
||||||
|
|
||||||
|
### 1. 用户认证模块 (LoginController)
|
||||||
|
路径前缀: `api/front`
|
||||||
|
|
||||||
|
| 方法 | 路径 | 说明 | App状态 |
|
||||||
|
|------|------|------|---------|
|
||||||
|
| POST | `/login` | 账号密码登录 | ✅ 已对接 |
|
||||||
|
| POST | `/register` | APP用户注册 | ✅ 已对接 |
|
||||||
|
| POST | `/login/mobile` | 手机号登录 | ❌ 未对接 |
|
||||||
|
| GET | `/logout` | 退出登录 | ❌ 未对接 |
|
||||||
|
| POST | `/sendCode` | 发送短信验证码 | ❌ 未对接 |
|
||||||
|
| POST | `/token/is/exist` | 校验token有效性 | ❌ 未对接 |
|
||||||
|
| GET | `/login/config` | 获取登录配置 | ❌ 未对接 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 2. 直播间模块 (LiveRoomController)
|
||||||
|
路径前缀: `api/front/live`
|
||||||
|
|
||||||
|
| 方法 | 路径 | 说明 | App状态 |
|
||||||
|
|------|------|------|---------|
|
||||||
|
| GET | `/public/rooms` | 获取直播间列表 | ✅ 已对接 |
|
||||||
|
| GET | `/public/rooms/{id}` | 获取直播间详情 | ✅ 已对接 |
|
||||||
|
| POST | `/rooms` | 创建直播间 | ✅ 已对接 |
|
||||||
|
| DELETE | `/rooms/{id}` | 删除直播间 | ✅ 已对接 |
|
||||||
|
| GET | `/public/rooms/{roomId}/messages` | 获取弹幕消息 | ✅ 已对接 |
|
||||||
|
| POST | `/public/rooms/{roomId}/messages` | 发送弹幕消息 | ❌ 未对接 |
|
||||||
|
| GET | `/public/rooms/{roomId}/viewers/count` | 获取观看人数 | ❌ 未对接 |
|
||||||
|
| POST | `/follow` | 关注/取消关注主播 | ❌ 未对接 |
|
||||||
|
| POST | `/srs/on_publish` | SRS推流开始回调 | 服务端 |
|
||||||
|
| POST | `/srs/on_unpublish` | SRS推流结束回调 | 服务端 |
|
||||||
|
| POST | `/srs/on_play` | SRS观看开始回调 | 服务端 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 3. 私聊会话模块 (ConversationController)
|
||||||
|
路径前缀: `api/front/conversations`
|
||||||
|
|
||||||
|
| 方法 | 路径 | 说明 | App状态 |
|
||||||
|
|------|------|------|---------|
|
||||||
|
| GET | `/` | 获取会话列表 | ❌ 未对接 |
|
||||||
|
| GET | `/search` | 搜索会话 | ❌ 未对接 |
|
||||||
|
| POST | `/with/{otherUserId}` | 获取或创建会话 | ❌ 未对接 |
|
||||||
|
| POST | `/{id}/read` | 标记会话已读 | ❌ 未对接 |
|
||||||
|
| DELETE | `/{id}` | 删除会话 | ❌ 未对接 |
|
||||||
|
| GET | `/{id}/messages` | 获取消息列表 | ❌ 未对接 |
|
||||||
|
| POST | `/{id}/messages` | 发送私信 | ❌ 未对接 |
|
||||||
|
| DELETE | `/messages/{id}` | 删除消息 | ❌ 未对接 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 4. 好友管理模块 (FriendController)
|
||||||
|
路径前缀: `api/front`
|
||||||
|
|
||||||
|
| 方法 | 路径 | 说明 | App状态 |
|
||||||
|
|------|------|------|---------|
|
||||||
|
| GET | `/users/search` | 搜索用户 | ❌ 未对接 |
|
||||||
|
| POST | `/friends/request` | 发送好友请求 | ❌ 未对接 |
|
||||||
|
| GET | `/friends/requests` | 获取好友请求列表 | ❌ 未对接 |
|
||||||
|
| POST | `/friends/requests/{requestId}/handle` | 处理好友请求 | ❌ 未对接 |
|
||||||
|
| GET | `/friends` | 获取好友列表 | ❌ 未对接 |
|
||||||
|
| DELETE | `/friends/{friendId}` | 删除好友 | ❌ 未对接 |
|
||||||
|
| PUT | `/friends/{friendId}/remark` | 更新好友备注 | ❌ 未对接 |
|
||||||
|
| GET | `/friends/requests/unread-count` | 获取未读请求数量 | ❌ 未对接 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 5. 群组管理模块 (GroupController)
|
||||||
|
路径前缀: `api/front/groups`
|
||||||
|
|
||||||
|
| 方法 | 路径 | 说明 | App状态 |
|
||||||
|
|------|------|------|---------|
|
||||||
|
| POST | `/create` | 创建群组 | ❌ 未对接 |
|
||||||
|
| PUT | `/{groupId}` | 更新群组信息 | ❌ 未对接 |
|
||||||
|
| DELETE | `/{groupId}` | 解散群组 | ❌ 未对接 |
|
||||||
|
| GET | `/list` | 获取群组列表 | ❌ 未对接 |
|
||||||
|
| GET | `/{groupId}` | 获取群组详情 | ❌ 未对接 |
|
||||||
|
| PUT | `/{groupId}/announcement` | 更新群公告 | ❌ 未对接 |
|
||||||
|
| PUT | `/{groupId}/mute-all` | 设置全员禁言 | ❌ 未对接 |
|
||||||
|
| POST | `/{groupId}/members/invite` | 邀请成员 | ❌ 未对接 |
|
||||||
|
| DELETE | `/{groupId}/members/{userId}` | 移除成员 | ❌ 未对接 |
|
||||||
|
| POST | `/{groupId}/quit` | 退出群组 | ❌ 未对接 |
|
||||||
|
| GET | `/{groupId}/members` | 获取成员列表 | ❌ 未对接 |
|
||||||
|
| PUT | `/{groupId}/members/{userId}/admin` | 设置管理员 | ❌ 未对接 |
|
||||||
|
| PUT | `/{groupId}/members/{userId}/mute` | 禁言成员 | ❌ 未对接 |
|
||||||
|
| PUT | `/{groupId}/members/{userId}/unmute` | 取消禁言 | ❌ 未对接 |
|
||||||
|
| PUT | `/{groupId}/members/nickname` | 更新群昵称 | ❌ 未对接 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 6. 群组消息模块 (GroupMessageController)
|
||||||
|
路径前缀: `api/front/groups`
|
||||||
|
|
||||||
|
| 方法 | 路径 | 说明 | App状态 |
|
||||||
|
|------|------|------|---------|
|
||||||
|
| POST | `/{groupId}/messages` | 发送群组消息 | ❌ 未对接 |
|
||||||
|
| GET | `/{groupId}/messages` | 获取群组消息列表 | ❌ 未对接 |
|
||||||
|
| POST | `/messages/{messageId}/recall` | 撤回群组消息 | ❌ 未对接 |
|
||||||
|
| DELETE | `/messages/{messageId}` | 删除群组消息 | ❌ 未对接 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 7. 礼物打赏模块 (GiftController)
|
||||||
|
路径前缀: `api/front/gift`
|
||||||
|
|
||||||
|
| 方法 | 路径 | 说明 | App状态 |
|
||||||
|
|------|------|------|---------|
|
||||||
|
| GET | `/list` | 获取礼物列表 | ❌ 未对接 |
|
||||||
|
| GET | `/balance` | 获取用户余额 | ❌ 未对接 |
|
||||||
|
| POST | `/send` | 赠送礼物 | ❌ 未对接 |
|
||||||
|
| GET | `/recharge/options` | 获取充值选项 | ❌ 未对接 |
|
||||||
|
| POST | `/recharge/create` | 创建充值订单 | ❌ 未对接 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 8. 消息转发模块 (MessageForwardController)
|
||||||
|
路径前缀: `/api/front/messages/forward`
|
||||||
|
|
||||||
|
| 方法 | 路径 | 说明 | App状态 |
|
||||||
|
|------|------|------|---------|
|
||||||
|
| POST | `/friend` | 转发消息给好友 | ❌ 未对接 |
|
||||||
|
| POST | `/group` | 转发消息到群组 | ❌ 未对接 |
|
||||||
|
| POST | `/batch` | 批量转发消息 | ❌ 未对接 |
|
||||||
|
| GET | `/history` | 获取转发历史 | ❌ 未对接 |
|
||||||
|
| DELETE | `/{forwardId}` | 删除转发记录 | ❌ 未对接 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 9. 消息表情回应模块 (MessageReactionController)
|
||||||
|
路径前缀: `/api/front/messages/reactions`
|
||||||
|
|
||||||
|
| 方法 | 路径 | 说明 | App状态 |
|
||||||
|
|------|------|------|---------|
|
||||||
|
| POST | `/add` | 添加表情回应 | ❌ 未对接 |
|
||||||
|
| DELETE | `/remove` | 取消表情回应 | ❌ 未对接 |
|
||||||
|
| GET | `/list` | 获取表情回应列表 | ❌ 未对接 |
|
||||||
|
| GET | `/statistics` | 获取表情统计 | ❌ 未对接 |
|
||||||
|
| GET | `/users` | 获取回应用户列表 | ❌ 未对接 |
|
||||||
|
| GET | `/check` | 检查回应状态 | ❌ 未对接 |
|
||||||
|
| POST | `/toggle` | 切换表情回应 | ❌ 未对接 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 10. 消息撤回模块 (MessageRecallController)
|
||||||
|
路径前缀: `api/front/messages`
|
||||||
|
|
||||||
|
| 方法 | 路径 | 说明 | App状态 |
|
||||||
|
|------|------|------|---------|
|
||||||
|
| POST | `/private/{messageId}/recall` | 撤回私聊消息 | ❌ 未对接 |
|
||||||
|
| POST | `/group/{messageId}/recall` | 撤回群组消息 | ❌ 未对接 |
|
||||||
|
| GET | `/{messageId}/can-recall` | 检查是否可撤回 | ❌ 未对接 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 11. 消息搜索模块 (MessageSearchController)
|
||||||
|
路径前缀: `/api/front/messages/search`
|
||||||
|
|
||||||
|
| 方法 | 路径 | 说明 | App状态 |
|
||||||
|
|------|------|------|---------|
|
||||||
|
| GET | `/private` | 搜索私聊消息 | ❌ 未对接 |
|
||||||
|
| GET | `/group` | 搜索群组消息 | ❌ 未对接 |
|
||||||
|
| GET | `/conversation/{conversationId}` | 在会话中搜索 | ❌ 未对接 |
|
||||||
|
| GET | `/group/{groupId}` | 在群组中搜索 | ❌ 未对接 |
|
||||||
|
| GET | `/history` | 获取搜索历史 | ❌ 未对接 |
|
||||||
|
| DELETE | `/history` | 清除搜索历史 | ❌ 未对接 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 12. 通话功能模块 (CallController)
|
||||||
|
路径前缀: `/api/front/call`
|
||||||
|
|
||||||
|
| 方法 | 路径 | 说明 | App状态 |
|
||||||
|
|------|------|------|---------|
|
||||||
|
| POST | `/initiate` | 发起通话 | ❌ 未对接 |
|
||||||
|
| POST | `/accept/{callId}` | 接听通话 | ❌ 未对接 |
|
||||||
|
| POST | `/reject/{callId}` | 拒绝通话 | ❌ 未对接 |
|
||||||
|
| POST | `/cancel/{callId}` | 取消通话 | ❌ 未对接 |
|
||||||
|
| POST | `/end/{callId}` | 结束通话 | ❌ 未对接 |
|
||||||
|
| GET | `/history` | 获取通话记录 | ❌ 未对接 |
|
||||||
|
| DELETE | `/record/{recordId}` | 删除通话记录 | ❌ 未对接 |
|
||||||
|
| GET | `/missed/count` | 获取未接来电数 | ❌ 未对接 |
|
||||||
|
| GET | `/status` | 检查通话状态 | ❌ 未对接 |
|
||||||
|
| GET | `/detail/{callId}` | 获取通话详情 | ❌ 未对接 |
|
||||||
|
|
||||||
|
WebSocket信令: `/ws/call/{callId}`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 13. 用户中心模块 (UserController)
|
||||||
|
路径前缀: `api/front`
|
||||||
|
|
||||||
|
| 方法 | 路径 | 说明 | App状态 |
|
||||||
|
|------|------|------|---------|
|
||||||
|
| POST | `/register/reset` | 修改密码 | ❌ 未对接 |
|
||||||
|
| POST | `/user/edit` | 修改个人资料 | ❌ 未对接 |
|
||||||
|
| GET | `/user` | 获取用户信息 | ❌ 未对接 |
|
||||||
|
| POST | `/update/binding/verify` | 换绑手机号校验 | ❌ 未对接 |
|
||||||
|
| POST | `/update/binding` | 换绑手机号 | ❌ 未对接 |
|
||||||
|
| GET | `/menu/user` | 获取个人中心菜单 | ❌ 未对接 |
|
||||||
|
| GET | `/commission` | 推广数据 | ❌ 未对接 |
|
||||||
|
| GET | `/spread/commission/detail` | 推广佣金明细 | ❌ 未对接 |
|
||||||
|
| GET | `/spread/count/{type}` | 推广佣金/提现总和 | ❌ 未对接 |
|
||||||
|
| POST | `/extract/cash` | 提现申请 | ❌ 未对接 |
|
||||||
|
| GET | `/extract/record` | 提现记录 | ❌ 未对接 |
|
||||||
|
| GET | `/extract/user` | 提现用户信息 | ❌ 未对接 |
|
||||||
|
| GET | `/extract/bank` | 提现银行 | ❌ 未对接 |
|
||||||
|
| GET | `/user/level/grade` | 会员等级列表 | ❌ 未对接 |
|
||||||
|
| GET | `/spread/people/count` | 推广人统计 | ❌ 未对接 |
|
||||||
|
| GET | `/spread/people` | 推广人列表 | ❌ 未对接 |
|
||||||
|
| GET | `/integral/user` | 用户积分信息 | ❌ 未对接 |
|
||||||
|
| GET | `/integral/list` | 积分记录 | ❌ 未对接 |
|
||||||
|
| GET | `/user/expList` | 经验记录 | ❌ 未对接 |
|
||||||
|
| GET | `/user/balance` | 用户资金统计 | ❌ 未对接 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 三、优先级建议
|
||||||
|
|
||||||
|
### 高优先级(核心功能)
|
||||||
|
1. **私聊会话** - 用户间即时通讯基础
|
||||||
|
2. **好友管理** - 社交关系基础
|
||||||
|
3. **礼物打赏** - 核心变现功能
|
||||||
|
4. **用户信息** - 个人中心基础
|
||||||
|
|
||||||
|
### 中优先级(增强功能)
|
||||||
|
5. **群组管理** - 群聊功能
|
||||||
|
6. **群组消息** - 群聊消息
|
||||||
|
7. **通话功能** - 语音/视频通话
|
||||||
|
8. **消息撤回** - 消息管理
|
||||||
|
|
||||||
|
### 低优先级(高级功能)
|
||||||
|
9. **消息转发** - 消息分享
|
||||||
|
10. **消息表情** - 互动增强
|
||||||
|
11. **消息搜索** - 历史查找
|
||||||
|
12. **用户中心高级功能** - 推广、提现等
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 四、Android App 当前 ApiService 接口
|
||||||
|
|
||||||
|
```java
|
||||||
|
public interface ApiService {
|
||||||
|
@POST("api/front/login")
|
||||||
|
Call<ApiResponse<LoginResponse>> login(@Body LoginRequest body);
|
||||||
|
|
||||||
|
@POST("api/front/register")
|
||||||
|
Call<ApiResponse<LoginResponse>> register(@Body RegisterRequest body);
|
||||||
|
|
||||||
|
@GET("api/front/live/public/rooms")
|
||||||
|
Call<ApiResponse<List<Room>>> getRooms();
|
||||||
|
|
||||||
|
@POST("api/front/live/rooms")
|
||||||
|
Call<ApiResponse<Room>> createRoom(@Body CreateRoomRequest body);
|
||||||
|
|
||||||
|
@GET("api/front/live/public/rooms/{id}")
|
||||||
|
Call<ApiResponse<Room>> getRoom(@Path("id") String id);
|
||||||
|
|
||||||
|
@DELETE("api/front/live/rooms/{id}")
|
||||||
|
Call<ApiResponse<Object>> deleteRoom(@Path("id") String id);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**结论**: Android App 目前只对接了 6 个接口,后端已实现约 106 个接口,对接率约 5.7%。
|
||||||
292
Log/系统/后端接口缺失分析报告.md
Normal file
292
Log/系统/后端接口缺失分析报告.md
Normal file
|
|
@ -0,0 +1,292 @@
|
||||||
|
# 直播社交接口分析报告
|
||||||
|
|
||||||
|
> **生成时间**: 2024年12月26日
|
||||||
|
> **分析范围**: Android App 与 Zhibo-H 后端直播社交接口对比
|
||||||
|
> **说明**: 本报告只分析直播社交相关接口,不包含电商接口(电商接口后端已有CRMEB原有实现)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📊 总体概况
|
||||||
|
|
||||||
|
### 一、后端接口状态统计
|
||||||
|
|
||||||
|
| 分类 | 后端已实现 | 后端未实现 | 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%
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## ✅ 已实现的接口
|
||||||
|
|
||||||
|
### 1. 用户认证模块 (5/7)
|
||||||
|
| 接口 | 路径 | 状态 |
|
||||||
|
|------|------|------|
|
||||||
|
| 账号密码登录 | `POST /api/front/login` | ✅ |
|
||||||
|
| 手机号登录 | `POST /api/front/login/mobile` | ✅ |
|
||||||
|
| 用户注册 | `POST /api/front/register` | ✅ |
|
||||||
|
| 发送验证码 | `POST /api/front/sendCode` | ✅ |
|
||||||
|
| 退出登录 | `GET /api/front/logout` | ✅ |
|
||||||
|
| Token校验 | `POST /api/front/token/is/exist` | ✅ |
|
||||||
|
|
||||||
|
### 2. 用户资料模块 (4/10)
|
||||||
|
| 接口 | 路径 | 状态 |
|
||||||
|
|------|------|------|
|
||||||
|
| 获取用户中心信息 | `GET /api/front/user` | ✅ |
|
||||||
|
| 修改个人资料 | `POST /api/front/user/edit` | ✅ |
|
||||||
|
| 修改密码 | `POST /api/front/register/reset` | ✅ |
|
||||||
|
| 换绑手机号 | `POST /api/front/update/binding` | ✅ |
|
||||||
|
|
||||||
|
### 3. 直播间模块 (8/13)
|
||||||
|
| 接口 | 路径 | 状态 |
|
||||||
|
|------|------|------|
|
||||||
|
| 获取直播间列表 | `GET /api/front/live/public/rooms` | ✅ |
|
||||||
|
| 获取直播间详情 | `GET /api/front/live/public/rooms/{id}` | ✅ |
|
||||||
|
| 创建直播间 | `POST /api/front/live/rooms` | ✅ |
|
||||||
|
| 删除直播间 | `DELETE /api/front/live/rooms/{id}` | ✅ |
|
||||||
|
| 获取弹幕消息 | `GET /api/front/live/public/rooms/{roomId}/messages` | ✅ |
|
||||||
|
| 发送弹幕消息 | `POST /api/front/live/public/rooms/{roomId}/messages` | ✅ |
|
||||||
|
| 获取观看人数 | `GET /api/front/live/public/rooms/{roomId}/viewers/count` | ✅ |
|
||||||
|
| 关注/取消关注主播 | `POST /api/front/live/follow` | ✅ (框架) |
|
||||||
|
|
||||||
|
### 4. 私聊消息模块 (9/11)
|
||||||
|
| 接口 | 路径 | 状态 |
|
||||||
|
|------|------|------|
|
||||||
|
| 获取会话列表 | `GET /api/front/conversations` | ✅ |
|
||||||
|
| 搜索会话 | `GET /api/front/conversations/search` | ✅ |
|
||||||
|
| 获取/创建会话 | `POST /api/front/conversations/with/{otherUserId}` | ✅ |
|
||||||
|
| 标记会话已读 | `POST /api/front/conversations/{id}/read` | ✅ |
|
||||||
|
| 删除会话 | `DELETE /api/front/conversations/{id}` | ✅ |
|
||||||
|
| 获取消息列表 | `GET /api/front/conversations/{id}/messages` | ✅ |
|
||||||
|
| 发送私信 | `POST /api/front/conversations/{id}/messages` | ✅ |
|
||||||
|
| 删除消息 | `DELETE /api/front/conversations/messages/{id}` | ✅ |
|
||||||
|
| 撤回消息 | `POST /api/front/conversations/messages/{id}/recall` | ✅ |
|
||||||
|
| 获取消息详情 | `GET /api/front/conversations/messages/{id}` | ✅ |
|
||||||
|
|
||||||
|
### 5. 好友管理模块 (6/6) ✅ 完成
|
||||||
|
| 接口 | 路径 | 状态 |
|
||||||
|
|------|------|------|
|
||||||
|
| 搜索用户 | `GET /api/front/users/search` | ✅ |
|
||||||
|
| 发送好友请求 | `POST /api/front/friends/request` | ✅ |
|
||||||
|
| 获取好友请求列表 | `GET /api/front/friends/requests` | ✅ |
|
||||||
|
| 处理好友请求 | `POST /api/front/friends/requests/{id}/handle` | ✅ |
|
||||||
|
| 获取好友列表 | `GET /api/front/friends` | ✅ |
|
||||||
|
| 删除好友 | `DELETE /api/front/friends/{friendId}` | ✅ |
|
||||||
|
|
||||||
|
### 6. 礼物打赏模块 (5/6)
|
||||||
|
| 接口 | 路径 | 状态 |
|
||||||
|
|------|------|------|
|
||||||
|
| 获取礼物列表 | `GET /api/front/gift/list` | ✅ |
|
||||||
|
| 获取用户余额 | `GET /api/front/gift/balance` | ✅ |
|
||||||
|
| 赠送礼物 | `POST /api/front/gift/send` | ✅ |
|
||||||
|
| 获取充值选项 | `GET /api/front/gift/recharge/options` | ✅ |
|
||||||
|
| 创建充值订单 | `POST /api/front/gift/recharge/create` | ✅ |
|
||||||
|
|
||||||
|
### 7. 通话模块 (10/10) ✅ 完成 (刚实现)
|
||||||
|
| 接口 | 路径 | 状态 |
|
||||||
|
|------|------|------|
|
||||||
|
| 发起通话 | `POST /api/front/call/initiate` | ✅ |
|
||||||
|
| 接听通话 | `POST /api/front/call/accept/{callId}` | ✅ |
|
||||||
|
| 拒绝通话 | `POST /api/front/call/reject/{callId}` | ✅ |
|
||||||
|
| 取消通话 | `POST /api/front/call/cancel/{callId}` | ✅ |
|
||||||
|
| 结束通话 | `POST /api/front/call/end/{callId}` | ✅ |
|
||||||
|
| 获取通话记录 | `GET /api/front/call/history` | ✅ |
|
||||||
|
| 删除通话记录 | `DELETE /api/front/call/record/{recordId}` | ✅ |
|
||||||
|
| 获取未接来电数 | `GET /api/front/call/missed/count` | ✅ |
|
||||||
|
| 获取通话状态 | `GET /api/front/call/status` | ✅ |
|
||||||
|
| 获取通话详情 | `GET /api/front/call/detail/{callId}` | ✅ |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## ❌ 未实现的接口
|
||||||
|
|
||||||
|
### 1. 用户资料模块 (缺失 6 个)
|
||||||
|
| 接口 | 期望路径 | 优先级 | 说明 |
|
||||||
|
|------|----------|--------|------|
|
||||||
|
| 上传头像 | `POST /api/front/user/avatar` | 高 | App EditProfileActivity 需要 |
|
||||||
|
| 获取用户详情 | `GET /api/front/user/info` | 高 | 多处需要获取用户信息 |
|
||||||
|
| 获取其他用户资料 | `GET /api/front/user/profile/{userId}` | 高 | 查看他人主页 |
|
||||||
|
| 获取登录设备列表 | `GET /api/front/user/devices` | 低 | 设备管理功能 |
|
||||||
|
| 踢出设备 | `DELETE /api/front/user/devices/{deviceId}` | 低 | 设备管理功能 |
|
||||||
|
| 注销账号 | `POST /api/front/user/delete` | 低 | 账号注销 |
|
||||||
|
|
||||||
|
### 2. 直播间模块 (缺失 5 个)
|
||||||
|
| 接口 | 期望路径 | 优先级 | 说明 |
|
||||||
|
|------|----------|--------|------|
|
||||||
|
| 获取房间分类列表 | `GET /api/front/live/categories` | 中 | 分类筛选 |
|
||||||
|
| 按分类获取房间 | `GET /api/front/live/rooms?category={id}` | 中 | 分类筛选 |
|
||||||
|
| 获取关注主播的直播间 | `GET /api/front/live/following/rooms` | 高 | 关注页面 |
|
||||||
|
| 获取推荐直播间 | `GET /api/front/live/recommend` | 中 | 发现页面 |
|
||||||
|
| 点赞/取消点赞房间 | `POST /api/front/live/rooms/{id}/like` | 低 | 房间点赞 |
|
||||||
|
|
||||||
|
### 3. 私聊消息模块 (缺失 2 个)
|
||||||
|
| 接口 | 期望路径 | 优先级 | 说明 |
|
||||||
|
|------|----------|--------|------|
|
||||||
|
| 获取未读消息总数 | `GET /api/front/messages/unread/count` | 高 | 消息红点 |
|
||||||
|
| 转发消息 | `POST /api/front/conversations/messages/{id}/forward` | 低 | 消息转发 |
|
||||||
|
|
||||||
|
### 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. 搜索功能模块 (缺失 4 个)
|
||||||
|
| 接口 | 期望路径 | 优先级 | 说明 |
|
||||||
|
|------|----------|--------|------|
|
||||||
|
| 综合搜索 | `GET /api/front/search` | 高 | 搜索用户/直播间/作品 |
|
||||||
|
| 搜索直播间 | `GET /api/front/search/rooms` | 中 | 搜索直播间 |
|
||||||
|
| 搜索作品 | `GET /api/front/search/works` | 中 | 搜索作品 |
|
||||||
|
| 获取热门搜索 | `GET /api/front/search/hot` | 低 | 热门搜索词 |
|
||||||
|
|
||||||
|
### 7. 作品管理模块 (缺失 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` | 中 | 作品收藏 |
|
||||||
|
|
||||||
|
### 8. 评论功能模块 (缺失 4 个)
|
||||||
|
| 接口 | 期望路径 | 优先级 | 说明 |
|
||||||
|
|------|----------|--------|------|
|
||||||
|
| 获取评论列表 | `GET /api/front/works/{id}/comments` | 中 | 作品评论 |
|
||||||
|
| 发表评论 | `POST /api/front/works/{id}/comments` | 中 | 发表评论 |
|
||||||
|
| 回复评论 | `POST /api/front/comments/{id}/reply` | 中 | 回复评论 |
|
||||||
|
| 删除评论 | `DELETE /api/front/comments/{id}` | 低 | 删除评论 |
|
||||||
|
|
||||||
|
### 9. 文件上传模块 (缺失 2 个)
|
||||||
|
| 接口 | 期望路径 | 优先级 | 说明 |
|
||||||
|
|------|----------|--------|------|
|
||||||
|
| 上传图片 | `POST /api/front/upload/image` | 高 | 通用图片上传 |
|
||||||
|
| 上传视频 | `POST /api/front/upload/video` | 中 | 视频上传 |
|
||||||
|
|
||||||
|
### 10. 其他功能 (缺失 8 个)
|
||||||
|
| 接口 | 期望路径 | 优先级 | 说明 |
|
||||||
|
|------|----------|--------|------|
|
||||||
|
| 获取首页标签配置 | `GET /api/front/home/tabs` | 中 | 首页标签 |
|
||||||
|
| 记录播放开始 | `POST /api/front/play/start` | 低 | 播放统计 |
|
||||||
|
| 记录播放结束 | `POST /api/front/play/end` | 低 | 播放统计 |
|
||||||
|
| 获取分享链接 | `GET /api/front/share/profile/{userId}` | 低 | 分享功能 |
|
||||||
|
| 记录分享行为 | `POST /api/front/share/record` | 低 | 分享统计 |
|
||||||
|
| 获取观看历史 | `GET /api/front/watch/history` | 低 | 观看历史 |
|
||||||
|
| 意见反馈 | `POST /api/front/feedback` | 低 | 意见反馈 |
|
||||||
|
| 获取APP版本 | `GET /api/front/app/version` | 低 | 版本检查 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🎯 优先级建议
|
||||||
|
|
||||||
|
### 第一优先级 (高) - 核心功能
|
||||||
|
1. **社交功能** - 关注/粉丝系统 (8个接口)
|
||||||
|
2. **通知推送** - 通知列表和管理 (5个接口)
|
||||||
|
3. **用户资料** - 头像上传、用户详情 (3个接口)
|
||||||
|
4. **未读消息** - 消息红点显示 (1个接口)
|
||||||
|
5. **文件上传** - 图片上传接口 (1个接口)
|
||||||
|
|
||||||
|
### 第二优先级 (中) - 增强功能
|
||||||
|
1. **作品管理** - 发布、列表、详情 (6个接口)
|
||||||
|
2. **搜索功能** - 综合搜索 (4个接口)
|
||||||
|
3. **直播间分类** - 分类筛选 (3个接口)
|
||||||
|
4. **评论功能** - 作品评论 (4个接口)
|
||||||
|
|
||||||
|
### 第三优先级 (低) - 辅助功能
|
||||||
|
1. 设备管理
|
||||||
|
2. 播放统计
|
||||||
|
3. 分享功能
|
||||||
|
4. 观看历史
|
||||||
|
5. 意见反馈
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📝 实现建议
|
||||||
|
|
||||||
|
### 1. 社交功能实现方案
|
||||||
|
需要创建以下数据库表:
|
||||||
|
- `eb_user_follow` - 关注关系表
|
||||||
|
- 字段:id, user_id, follow_user_id, create_time
|
||||||
|
|
||||||
|
需要创建的类:
|
||||||
|
- `FollowController` - 关注控制器
|
||||||
|
- `FollowService` / `FollowServiceImpl` - 关注服务
|
||||||
|
- `FollowDao` - 数据访问层
|
||||||
|
- `UserFollow` - 实体类 (JPA)
|
||||||
|
|
||||||
|
### 2. 通知推送实现方案
|
||||||
|
需要创建以下数据库表:
|
||||||
|
- `eb_notification` - 通知表
|
||||||
|
- 字段:id, user_id, type, title, content, is_read, create_time
|
||||||
|
|
||||||
|
需要创建的类:
|
||||||
|
- `NotificationController` - 通知控制器
|
||||||
|
- `NotificationService` / `NotificationServiceImpl` - 通知服务
|
||||||
|
- `NotificationDao` - 数据访问层
|
||||||
|
- `Notification` - 实体类 (JPA)
|
||||||
|
|
||||||
|
### 3. 作品管理实现方案
|
||||||
|
需要创建以下数据库表:
|
||||||
|
- `eb_work` - 作品表
|
||||||
|
- `eb_work_like` - 作品点赞表
|
||||||
|
- `eb_work_collect` - 作品收藏表
|
||||||
|
- `eb_work_comment` - 作品评论表
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📊 工作量估算
|
||||||
|
|
||||||
|
| 模块 | 接口数 | 预计工时 |
|
||||||
|
|------|--------|----------|
|
||||||
|
| 社交功能 | 8 | 3-4天 |
|
||||||
|
| 通知推送 | 5 | 2-3天 |
|
||||||
|
| 作品管理 | 6 | 3-4天 |
|
||||||
|
| 评论功能 | 4 | 2天 |
|
||||||
|
| 搜索功能 | 4 | 2天 |
|
||||||
|
| 用户资料补充 | 6 | 2天 |
|
||||||
|
| 直播间补充 | 5 | 2天 |
|
||||||
|
| 其他功能 | 10 | 3天 |
|
||||||
|
|
||||||
|
**总计预估**: 19-22 个工作日
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**报告生成时间**: 2024年12月26日
|
||||||
280
Log/系统/直播接口完整分析报告.md
Normal file
280
Log/系统/直播接口完整分析报告.md
Normal file
|
|
@ -0,0 +1,280 @@
|
||||||
|
# 直播社交接口完整分析报告
|
||||||
|
|
||||||
|
> **生成时间**: 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日
|
||||||
Loading…
Reference in New Issue
Block a user