huanghaosheng/VLoop
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update readme.md

Browse Source
This commit is contained in:
Leon
2025-12-13 23:26:12 +08:00
parent 8e51de9410
commit a1d49f0ab1
1 changed files with 74 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

122
README.md
View File

@@ -1,61 +1,87 @@
# feedsystem_video_go
# feedsystem_video_go
## 项目简介
基于 Go 的视频 feed 系统，提供用户注册 / 登录、视频发布与点赞、Feed 拉取等接口，默认使用 Gin + GORM + MySQL。仓库附带 Postman Collection 方便调试 API。
基于 Go 的视频 Feed 系统后端，提供账号注册/登录、视频发布与查询、点赞/取消点赞、Feed 拉取等接口。默认使用 `Gin + GORM + MySQL + JWT`。
仓库内附 Postman Collection（见 `test/*.json`）方便调试 API。
## 目录结构
- `cmd/`：程序入口（`main.go`）
- `configs/`：YAML 配置（`config.yaml`）
- `internal/account/`：账号实体、仓储与业务逻辑
- `cmd/`：程序入口（`cmd/main.go`）
- `configs/`：YAML 配置（`configs/config.yaml`）
- `internal/account/`：账号模块（实体/仓储/服务/HTTP handler）
- `internal/video/`：视频与点赞模块
- `internal/feed/`：Feed 列表
- `internal/http/`：HTTP 路由
- `test/`：Postman Collection（`account.json` 等）
- `start.sh`：启动脚本示例
- `internal/feed/`：Feed 拉取模块
- `internal/http/`：Gin 路由注册
- `internal/middleware/`：JWT 中间件
- `test/`：Postman Collection
## 快速开始
1. 准备 Go 1.21+ 与 MySQL 8+ 环境。
2. 创建 `feedsystem` 数据库并根据需要修改 `configs/config.yaml`。
3. 安装依赖：`go mod tidy`
4. 启动服务：`go run ./cmd`（或执行 `sh start.sh`）
5. 在 Postman 中导入 `test/*.json`，设置 `host=http://localhost:8080`、`jwt_token` 为登录返回的 token。
1. 准备 MySQL，并创建数据库（默认名 `feedsystem`，可在 `configs/config.yaml` 修改）。
2. 安装依赖：`go mod tidy`
3. 启动服务：`go run ./cmd`（端口默认 `8080`）
4. 导入 Postman：`test/*.json`，设置变量 `host=http://localhost:8080`、`jwt_token` 为登录返回的 token。
## 身份认证说明
- 公共接口：`/account/register`、`/account/login`、`/video/listByAuthorID`、`/video/getDetail`、`/like/getLikesCount`、`/feed/listLatest`。
- 需要 JWT 的接口：`/account/rename`、`/account/changePassword`、`/account/findByID`、`/account/findByUsername`、`/account/logout` 以及 `/video/publish`、`/like/*`。
- 授权头格式：`Authorization: Bearer <jwt>`。
- 用户修改密码后会立即使旧 token 失效，需要重新登录获取新的 JWT。
## 配置
配置文件：`configs/config.yaml`
## API（账号相关）
| 方法 | 路径 | 功能 | 请求体 |
|------|------|------|--------|
| POST | `/account/register` | 注册账号 | `{"username": "...","password": "..."}` |
| POST | `/account/login` | 登录，返回 `token` | `{"username": "...","password": "..."}` |
| POST | `/account/changePassword` | 修改当前登录用户的密码（需要 JWT） | `{"old_password": "...","new_password": "..."}` |
| POST | `/account/rename` | 修改当前登录用户的昵称（需要 JWT） | `{"new_username": "..."}` |
| POST | `/account/findByID` | 根据 ID 查询账号（需要 JWT） | `{"id": 1}` |
| POST | `/account/findByUsername` | 根据用户名查询账号（需要 JWT） | `{"username": "alice"}` |
| POST | `/account/logout` | 注销当前 token（需要 JWT） | `{}` |
```yaml
server:
port: 8080
- 所有接口统一使用 JSON 请求 / 响应。
- 启动时调用 `db.AutoMigrate` 保证表结构最新。
database:
host: localhost
port: 3306
user: root
password: 123456
dbname: feedsystem
```
## API（视频相关）
| 方法 | 路径 | 功能 | 请求体 |
|------|------|------|--------|
| POST | `/video/listByAuthorID` | 根据作者 ID 获取视频列表 | `{"author_id": 1}` |
| POST | `/video/getDetail` | 查询指定视频详情 | `{"id": 1}` |
| POST | `/video/publish` | 发布视频（需要 JWT，自动读取登录用户为作者） | `{"title": "...","description": "...","play_url": "http://..."}` |
## 认证说明（与代码一致）
- Header：`Authorization: Bearer <jwt>`
- JWT 解析成功后，还会校验该 token 是否等于数据库里账号当前保存的 token（见 `internal/middleware/jwt.go`），因此：
- 同一账号再次登录会覆盖 token，旧 token 失效
- `/account/logout` 会清空 token，token 立即失效
- `/account/changePassword` 成功后也会清空 token（需要重新登录拿新 token）
## API（点赞相关）
| 方法 | 路径 | 功能 | 请求体 |
|------|------|------|--------|
| POST | `/like/getLikesCount` | 获取视频点赞总数 | `{"video_id": 1}` |
| POST | `/like/like` | 给视频点赞（需要 JWT） | `{"video_id": 1}` |
| POST | `/like/unlike` | 取消点赞（需要 JWT） | `{"video_id": 1}` |
| POST | `/like/isLiked` | 判断当前用户是否点赞（需要 JWT） | `{"video_id": 1}` |
## API（路由与鉴权）
路由注册见 `internal/http/router.go`。
## API（Feed 相关）
| 方法 | 路径 | 功能 | 请求体 |
|------|------|------|--------|
| POST | `/feed/listLatest` | 拉取瀑布流，`limit` 最大 50，`latest_time` 为空时默认当前时间 | `{"limit": 10,"latest_time": 0}` |
### 账号（/account）
| 方法 | 路径 | 是否需要 JWT | 功能 | 请求体示例 |
|------|------|-------------|------|-----------|
| POST | `/account/register` | 否 | 注册账号 | `{"username":"alice","password":"pass123"}` |
| POST | `/account/login` | 否 | 登录，返回 `token` | `{"username":"alice","password":"pass123"}` |
| POST | `/account/changePassword` | 否 | 修改指定用户名密码（会校验旧密码） | `{"username":"alice","old_password":"pass123","new_password":"newpass456"}` |
| POST | `/account/findByID` | 否 | 按 ID 查询账号 | `{"id":1}` |
| POST | `/account/findByUsername` | 否 | 按用户名查询账号 | `{"username":"alice"}` |
| POST | `/account/rename` | 是 | 修改当前登录用户用户名 | `{"new_username":"alice_new"}` |
| POST | `/account/logout` | 是 | 注销（撤销当前 token） | `{}` |
### 视频（/video）
| 方法 | 路径 | 是否需要 JWT | 功能 | 请求体示例 |
|------|------|-------------|------|-----------|
| POST | `/video/listByAuthorID` | 否 | 按作者 ID 列出视频（不分页） | `{"author_id":1}` |
| POST | `/video/getDetail` | 否 | 查询视频详情 | `{"id":1}` |
| POST | `/video/publish` | 是 | 发布视频（作者取自 JWT） | `{"title":"demo","description":"...","play_url":"http://...","cover_url":"http://..."}` |
说明：发布视频时 `title`、`play_url`、`cover_url` 为必填字段（见 `internal/video/video_service.go`）。
### 点赞（/like）
| 方法 | 路径 | 是否需要 JWT | 功能 | 请求体示例 |
|------|------|-------------|------|-----------|
| POST | `/like/getLikesCount` | 否 | 获取视频点赞总数 | `{"video_id":1}` |
| POST | `/like/isLiked` | 是 | 当前用户是否点赞 | `{"video_id":1}` |
| POST | `/like/like` | 是 | 点赞 | `{"video_id":1}` |
| POST | `/like/unlike` | 是 | 取消点赞 | `{"video_id":1}` |
### Feed（/feed）
| 方法 | 路径 | 是否需要 JWT | 功能 | 请求体示例 |
|------|------|-------------|------|-----------|
| POST | `/feed/listLatest` | 否 | 拉取最新 Feed（按 `create_time` 倒序），`limit` 最大 50 | `{"limit":10,"latest_time":0}` |
说明：
- `latest_time` 是 Unix 秒时间戳；当 `latest_time=0` 或不传时，返回最新一页（见 `internal/feed/handler.go`）。
- 响应里的 `next_time` 是 JSON 序列化后的 `time.Time`（RFC3339 字符串，见 `internal/feed/service.go`）。下一页请求时，需要把它转换为 Unix 秒时间戳再传回 `latest_time`。
## 数据表（自动迁移）
启动时会执行 `AutoMigrate` 创建/更新表结构：`Account`、`Video`、`Like`（见 `internal/db/db.go`）。