6.1 KiB
6.1 KiB
待完成接入接口清单
更新时间: 2024-12-30
📊 总体情况
| 类别 | 后端接口数 | Android已接入 | 待接入 |
|---|---|---|---|
| 总计 | 131 | ~85 | ~46 |
✅ 已接入模块 (无需处理)
| 模块 | 接口数 | 状态 |
|---|---|---|
| 用户认证 | 4 | ✅ 全部接入 |
| 用户信息 | 2 | ✅ 全部接入 |
| 直播间 | 6 | ✅ 全部接入 |
| 直播弹幕 | 2 | ✅ 全部接入 |
| 礼物打赏 | 5 | ✅ 全部接入 |
| 私聊会话 | 8 | ✅ 全部接入 |
| 好友管理 | 9 | ✅ 全部接入 |
| 文件上传 | 2 | ✅ 全部接入 |
| 在线状态 | 5 | ✅ 全部接入 |
| 离线消息 | 3 | ✅ 全部接入 |
| 消息表情回应 | 4 | ✅ 全部接入 |
| 关注功能 | 7 | ✅ 全部接入 |
| 作品管理 | 13 | ✅ 全部接入 |
| 搜索功能 | 9 | ✅ 全部接入 |
| 支付集成 | 4 | ✅ 全部接入 |
| 通话功能 | 10 | ✅ 全部接入 |
❌ 待接入模块
1. 群组管理 (10个接口) - 🔴 高优先级
后端已完成,Android端未定义接口。
| 接口 | 路径 | 说明 |
|---|---|---|
| 创建群组 | POST /api/front/groups/create |
创建新群组 |
| 群组列表 | GET /api/front/groups/list |
获取我的群组 |
| 群组详情 | GET /api/front/groups/{groupId} |
获取群组信息 |
| 更新群组 | PUT /api/front/groups/{groupId} |
修改群组信息 |
| 解散群组 | DELETE /api/front/groups/{groupId} |
解散群组 |
| 添加成员 | POST /api/front/groups/{groupId}/members |
邀请成员 |
| 移除成员 | DELETE /api/front/groups/{groupId}/members/{userId} |
踢出成员 |
| 成员列表 | GET /api/front/groups/{groupId}/members |
获取成员 |
| 退出群组 | POST /api/front/groups/{groupId}/leave |
主动退群 |
| 转让群主 | POST /api/front/groups/{groupId}/transfer |
转让群主 |
2. 群组消息 (4个接口) - 🔴 高优先级
| 接口 | 路径 | 说明 |
|---|---|---|
| 发送群消息 | POST /api/front/groups/{groupId}/messages |
发送消息 |
| 群消息历史 | GET /api/front/groups/{groupId}/messages |
获取历史 |
| 撤回消息 | DELETE /api/front/groups/{groupId}/messages/{messageId} |
撤回消息 |
| 转发消息 | POST /api/front/groups/{groupId}/messages/{messageId}/forward |
转发消息 |
3. 消息搜索 (3个接口) - 🟡 中优先级
| 接口 | 路径 | 说明 |
|---|---|---|
| 搜索会话 | GET /api/front/messages/search/conversations |
搜索会话 |
| 搜索消息 | GET /api/front/messages/search/messages |
搜索消息内容 |
| 全局搜索 | GET /api/front/messages/search/global |
全局搜索 |
4. 评论功能 (8个接口) - 🟡 中优先级
| 接口 | 路径 | 说明 |
|---|---|---|
| 发布评论 | POST /api/front/works/comment/publish |
发布评论 |
| 评论列表 | GET /api/front/works/comment/list/{worksId} |
获取评论 |
| 点赞评论 | POST /api/front/works/comment/like/{commentId} |
点赞 |
| 取消点赞 | POST /api/front/works/comment/unlike/{commentId} |
取消点赞 |
| 删除评论 | POST /api/front/works/comment/delete/{commentId} |
删除评论 |
| 回复列表 | GET /api/front/works/comment/reply/list/{commentId} |
获取回复 |
| 评论详情 | GET /api/front/works/comment/detail/{commentId} |
评论详情 |
| 检查点赞 | GET /api/front/works/comment/check-liked/{commentId} |
检查状态 |
5. 通知推送 (9个接口) - 🟡 中优先级
| 接口 | 路径 | 说明 |
|---|---|---|
| 通知列表 | GET /api/front/notification/list |
获取通知 |
| 未读数量 | GET /api/front/notification/unread-count |
未读数 |
| 标记已读 | POST /api/front/notification/mark-read/{id} |
单条已读 |
| 全部已读 | POST /api/front/notification/mark-all-read |
全部已读 |
| 注册FCM | POST /api/front/notification/fcm/register |
注册推送 |
| 移除FCM | POST /api/front/notification/fcm/remove |
移除推送 |
| 删除通知 | DELETE /api/front/notification/{id} |
删除单条 |
| 清空通知 | DELETE /api/front/notification/clear-all |
清空全部 |
| 按类型统计 | GET /api/front/notification/unread-count-by-type |
分类统计 |
6. 分类管理 (7个接口) - 🟢 低优先级
| 接口 | 路径 | 说明 |
|---|---|---|
| 直播间分类 | GET /api/front/category/live-room |
直播分类 |
| 作品分类 | GET /api/front/category/work |
作品分类 |
| 分类列表 | GET /api/front/category/list |
全部分类 |
| 分类详情 | GET /api/front/category/{id} |
分类详情 |
| 分类统计 | GET /api/front/category/statistics |
统计数据 |
| 热门分类 | GET /api/front/category/hot |
热门分类 |
| 子分类 | GET /api/front/category/{parentId}/children |
子分类 |
7. 文件上传补充 (3个接口) - 🟢 低优先级
| 接口 | 路径 | 说明 |
|---|---|---|
| 通用图片上传 | POST /api/upload/image |
通用图片 |
| 通用文件上传 | POST /api/upload/file |
通用文件 |
| 语音上传 | POST /api/upload/chat/voice |
语音消息 |
8. 直播间补充 (4个接口) - 🟢 低优先级
| 接口 | 路径 | 说明 |
|---|---|---|
| 开始直播 | POST /api/front/live/room/{id}/start |
开播 |
| 结束直播 | POST /api/front/live/room/{id}/stop |
停播 |
| 观众列表 | GET /api/rooms/{roomId}/viewers |
观众列表 |
| 手动广播人数 | POST /api/live/online/broadcast/{roomId} |
广播人数 |
📋 接入优先级建议
第一优先级 (核心社交)
- 群组管理 - 10个接口
- 群组消息 - 4个接口
第二优先级 (内容互动)
- 评论功能 - 8个接口
- 通知推送 - 9个接口
第三优先级 (辅助功能)
- 消息搜索 - 3个接口
- 分类管理 - 7个接口
- 文件上传补充 - 3个接口
- 直播间补充 - 4个接口
📝 备注
- 后端接口已全部完成 (131个)
- Android端已接入约85个接口
- 待接入约46个接口
- 核心功能已基本完成,待接入的主要是群组和辅助功能