146 lines
5.0 KiB
Markdown
146 lines
5.0 KiB
Markdown
# 直播IM系统接口文档总览
|
||
|
||
## 文档说明
|
||
|
||
本文档集按照功能模块组织，每个模块文档包含：
|
||
- 模块概述
|
||
- 接口列表
|
||
- 每个接口的请求参数和返回参数
|
||
|
||
**注意**: 本文档仅包含接口定义，不包含代码实现。
|
||
|
||
---
|
||
|
||
## 模块列表
|
||
|
||
### 已完成模块 (18个)
|
||
|
||
| 序号 | 模块名称 | 接口数量 | 文档文件 | 状态 |
|
||
|------|---------|---------|---------|------|
|
||
| 1 | 用户系统模块 | 7 | [01-用户系统模块.md](./01-用户系统模块.md) | ✅ 已完成 |
|
||
| 2 | 直播间管理模块 | 10 | [02-直播间管理模块.md](./02-直播间管理模块.md) | ✅ 已完成 |
|
||
| 3 | 直播间弹幕模块 | 2 | [03-直播间弹幕模块.md](./03-直播间弹幕模块.md) | ✅ 已完成 |
|
||
| 4 | WebSocket通信模块 | 2 | [04-WebSocket通信模块.md](./04-WebSocket通信模块.md) | ✅ 已完成 |
|
||
| 5 | 好友管理模块 | 9 | [05-好友管理模块.md](./05-好友管理模块.md) | ✅ 已完成 |
|
||
| 6 | 关注功能模块 | 7 | [06-关注功能模块.md](./06-关注功能模块.md) | ✅ 已完成 |
|
||
| 7 | 作品管理模块 | 15 | [07-作品管理模块.md](./07-作品管理模块.md) | ✅ 已完成 |
|
||
| 8 | 搜索功能模块 | 9 | [08-搜索功能模块.md](./08-搜索功能模块.md) | ✅ 已完成 |
|
||
| 9 | 支付集成模块 | 4 | [09-支付集成模块.md](./09-支付集成模块.md) | ✅ 已完成 |
|
||
| 10 | 分类管理模块 | 7 | [10-分类管理模块.md](./10-分类管理模块.md) | ✅ 已完成 |
|
||
| 11 | 消息表情回应模块 | 4 | [11-消息表情回应模块.md](./11-消息表情回应模块.md) | ✅ 已完成 |
|
||
| 12 | 私聊会话模块 | 8 | [12-私聊会话模块.md](./12-私聊会话模块.md) | ✅ 已完成 |
|
||
| 13 | 文件上传模块 | 2 | [13-文件上传模块.md](./13-文件上传模块.md) | ✅ 已完成 |
|
||
| 14 | 在线状态模块 | 5 | [14-在线状态模块.md](./14-在线状态模块.md) | ✅ 已完成 |
|
||
| 15 | 离线消息模块 | 3 | [15-离线消息模块.md](./15-离线消息模块.md) | ✅ 已完成 |
|
||
| 16 | 观看历史模块 | 1 | [16-观看历史模块.md](./16-观看历史模块.md) | ✅ 已完成 |
|
||
| 17 | 礼物打赏模块 | 5 | [17-礼物打赏模块.md](./17-礼物打赏模块.md) | ✅ 已完成 |
|
||
| 18 | 通话功能模块 | 10 | [18-通话功能模块.md](./18-通话功能模块.md) | ✅ 已完成 |
|
||
|
||
**总计**: 109个接口
|
||
|
||
---
|
||
|
||
## 快速导航
|
||
|
||
### 基础功能
|
||
- [用户系统模块](./01-用户系统模块.md) - 登录、注册、用户信息管理
|
||
- [分类管理模块](./10-分类管理模块.md) - 直播间和作品分类
|
||
|
||
### 直播功能
|
||
- [直播间管理模块](./02-直播间管理模块.md) - 直播间创建、控制、查询
|
||
- [直播间弹幕模块](./03-直播间弹幕模块.md) - 弹幕发送和历史记录
|
||
- [WebSocket通信模块](./04-WebSocket通信模块.md) - 实时弹幕和在线人数
|
||
|
||
### 社交功能
|
||
- [好友管理模块](./05-好友管理模块.md) - 好友添加、删除、拉黑
|
||
- [关注功能模块](./06-关注功能模块.md) - 用户关注和粉丝管理
|
||
- [私聊会话模块](./12-私聊会话模块.md) - 一对一聊天、消息发送
|
||
- [消息表情回应模块](./11-消息表情回应模块.md) - 消息表情回应
|
||
- [通话功能模块](./18-通话功能模块.md) - 语音/视频通话
|
||
|
||
### 内容功能
|
||
- [作品管理模块](./07-作品管理模块.md) - 作品发布、编辑、点赞、收藏
|
||
- [搜索功能模块](./08-搜索功能模块.md) - 用户、直播间、作品搜索
|
||
- [文件上传模块](./13-文件上传模块.md) - 图片和视频上传
|
||
|
||
### 支付功能
|
||
- [支付集成模块](./09-支付集成模块.md) - 金币充值和支付
|
||
- [礼物打赏模块](./17-礼物打赏模块.md) - 礼物赠送和余额管理
|
||
|
||
### 状态管理
|
||
- [在线状态模块](./14-在线状态模块.md) - 用户在线状态查询
|
||
- [离线消息模块](./15-离线消息模块.md) - 离线消息管理
|
||
- [观看历史模块](./16-观看历史模块.md) - 观看历史记录
|
||
|
||
---
|
||
|
||
## 接口规范
|
||
|
||
### 通用请求头
|
||
|
||
需要登录的接口需要携带以下请求头：
|
||
```
|
||
Authorization: Bearer {token}
|
||
```
|
||
|
||
### 通用响应格式
|
||
|
||
所有接口返回统一的响应格式：
|
||
```json
|
||
{
|
||
"code": 200,
|
||
"msg": "success",
|
||
"data": {}
|
||
}
|
||
```
|
||
|
||
**code说明**:
|
||
- 200: 成功
|
||
- 401: 未登录
|
||
- 403: 无权限
|
||
- 404: 资源不存在
|
||
- 500: 服务器错误
|
||
|
||
### 分页参数
|
||
|
||
支持分页的接口使用以下参数：
|
||
```
|
||
page 或 pageNum: 页码 (默认1)
|
||
pageSize: 每页数量 (默认20)
|
||
```
|
||
|
||
分页响应格式：
|
||
```json
|
||
{
|
||
"code": 200,
|
||
"msg": "success",
|
||
"data": {
|
||
"list": [],
|
||
"total": 总数,
|
||
"page": 当前页,
|
||
"pageSize": 每页数量
|
||
}
|
||
}
|
||
```
|
||
|
||
---
|
||
|
||
## 更新日志
|
||
|
||
### 2024-12-30
|
||
- 补充7个新模块文档
|
||
- 新增私聊会话、文件上传、在线状态、离线消息、观看历史、礼物打赏、通话功能模块
|
||
- 更新模块总数为18个，接口总数为109个
|
||
- 完善快速导航分类
|
||
|
||
### 2024-12-30
|
||
- 创建模块化接口文档
|
||
- 整理11个功能模块，共76个接口
|
||
- 删除旧的对接文档，统一使用模块文档
|
||
|
||
---
|
||
|
||
## 联系方式
|
||
|
||
如有问题，请在项目Issue中提出。
|