docs: Refresh deployment and API documentation
- Align deployment guidance with the current three-node Compose topology - Document the current frontend architecture and development workflow - Replace the stale API list with a controller-based route index
This commit is contained in:
Toys-A
+22
-141
@@ -1,142 +1,23 @@
|
||||
# HAOVP接口列表
|
||||
# HAOVP 接口索引
|
||||
|
||||
| 序号 | 接口名称 | 请求类型 | 接口路径 | 接口分组 |
|
||||
| ---- | ---------------------------- | -------- | ----------------------------------------------- | --------------------------------------------------- |
|
||||
| 1 | 用户登录 | POST | /auth/login | 根目录/video-auth/认证控制器 |
|
||||
| 2 | 用户注册 | POST | /auth/register | 根目录/video-auth/认证控制器 |
|
||||
| 3 | 生成验证码 | GET | /auth/captcha | 根目录/video-auth/认证控制器 |
|
||||
| 4 | 刷新令牌 | POST | /auth/refresh | 根目录/video-auth/认证控制器 |
|
||||
| 5 | 用户登出 | POST | /auth/logout | 根目录/video-auth/认证控制器 |
|
||||
| 6 | 获取当前用户信息 | GET | /auth/current | 根目录/video-auth/认证控制器 |
|
||||
| 7 | 根据ID获取用户名 | GET | /auth/username/{userId} | 根目录/video-auth/认证控制器 |
|
||||
| 8 | 获取登录统计－管理接口 | GET | /auth/admin/login/stats | 根目录/video-auth/认证管理控制器-供管理后台调用 |
|
||||
| 9 | 管理员重置用户密码－管理接口 | PUT | /auth/admin/reset-password/{userId} | 根目录/video-auth/认证管理控制器－供管理后台调用 |
|
||||
| 10 | 锁定/解锁用户账号－管理接口 | PUT | /auth/admin/lock/{userId}/{locked} | 根目录/video-auth/认证管理控制器－供管理后台调用 |
|
||||
| 11 | 关注用户 | POST | /user/follow/{followId} | 根目录/video-user/用户关注控制器 |
|
||||
| 12 | 取消关注 | DELETE | /user/follow/{followId} | 根目录/video-user/用户关注控制器 |
|
||||
| 13 | 获取用户关注列表 | GET | /user/follow/following/{userId} | 根目录/video-user/用户关注控制器 |
|
||||
| 14 | 获取用户粉丝列表 | GET | /user/follow/followers/{userId} | 根目录/video-user/用户关注控制器 |
|
||||
| 15 | 检查是否已关注 | GET | /user/follow/check/{followId} | 根目录/video-user/用户关注控制器 |
|
||||
| 16 | 发送私信 | POST | /user/message | 根目录/video-user/用户私信控制器 |
|
||||
| 17 | 获取私信列表(按会话分组) | GET | /user/message/list | 根目录/video-user/用户私信控制器 |
|
||||
| 18 | 获取与指定用户的私信记录 | GET | /user/message/detail/{targetId} | 根目录/video-user/用户私信控制器 |
|
||||
| 19 | 标记私信为已读 | PUT | /user/message/read/{senderId} | 根目录/video-user/用户私信控制器 |
|
||||
| 20 | 获取未读私信数量 | GET | /user/message/unread/count | 根目录/video-user/用户私信控制器 |
|
||||
| 21 | 初始化用户资料 | POST | /user/profile/init | 根目录/video-user/用户资料控制器 |
|
||||
| 22 | 获取当前用户资料 | GET | /user/profile/current | 根目录/video-user/用户资料控制器 |
|
||||
| 23 | 获取指定用户资料 | GET | /user/profile/public/{userId} | 根目录/video-user/用户资料控制器 |
|
||||
| 24 | 更新用户资料 | PUT | /user/profile | 根目录/video-user/用户资料控制器 |
|
||||
| 25 | 上传头像 | POST | /user/profile/avatar | 根目录/video-user/用户资料控制器 |
|
||||
| 26 | 搜索用户 | GET | /user/profile/search | 根目录/video-user/用户资料控制器 |
|
||||
| 27 | 增加用户视频数量 | POST | /user/profile/count/video/{userId}/{count} | 根目录/video-user/用户资料控制器 |
|
||||
| 28 | 增加用户获赞数量 | POST | /user/profile/count/like/{userId}/{count} | 根目录/video-user/用户资料控制器 |
|
||||
| 29 | 增加用户收藏数量 | POST | /user/profile/count/favorite/{userId}/{count} | 根目录/video-user/用户资料控制器 |
|
||||
| 30 | 获取用户设置 | GET | /user/setting | 根目录/video-user/用户设置控制器 |
|
||||
| 31 | 更新用户设置 | PUT | /user/setting | 根目录/video-user/用户设置控制器 |
|
||||
| 32 | 获取通知列表 | GET | /user/notification/list | 根目录/video-user/用户通知控制器 |
|
||||
| 33 | 标记通知为已读 | PUT | /user/notification/read | 根目录/video-user/用户通知控制器 |
|
||||
| 34 | 标记指定通知为已读 | PUT | /user/notification/read/{notificationId} | 根目录/video-user/用户通知控制器 |
|
||||
| 35 | 获取未读通知数量 | GET | /user/notification/unread/count | 根目录/video-user/用户通知控制器 |
|
||||
| 36 | 发送用户通知 | POST | /user/notification/send/{userId}/{type} | 根目录/video-user/用户通知控制器 |
|
||||
| 37 | 获取用户列表－管理接口 | GET | /user/profile/admin/list | 根目录/video-user/用户管理控制器－供管理后台调用 |
|
||||
| 38 | 获取用户详情－管理接口 | GET | /user/profile/admin/{userId} | 根目录/video-user/用户管理控制器－供管理后台调用 |
|
||||
| 39 | 禁用/启用用户－管理接口 | PUT | /user/profile/admin/status/{userId}/{status} | 根目录/video-user/用户管理控制器－供管理后台调用 |
|
||||
| 40 | 重置用户密码－管理接口 | PUT | /user/profile/admin/reset-password/{userId} | 根目录/video-user/用户管理控制器-供管理后台调用 |
|
||||
| 41 | 获取用户统计信息－管理接口 | GET | /user/profile/admin/stats | 根目录/video-user/用户管理控制器-供管理后台调用 |
|
||||
| 42 | 获取标签列表 | GET | /content/tag/list | 根目录/video-content/标签控制器 |
|
||||
| 43 | 分页获取标签列表 | GET | /content/tag/page | 根目录/video-content/标签控制器 |
|
||||
| 44 | 添加标签 | POST | /content/tag | 根目录/video-content/标签控制器 |
|
||||
| 45 | 更新标签 | PUT | /content/tag | 根目录/video-content/标签控制器 |
|
||||
| 46 | 删除标签 | DELETE | /content/tag/{id} | 根目录/video-content/标签控制器 |
|
||||
| 47 | 获取视频标签 | GET | /content/tag/video/{videoId} | 根目录/video-content/标签控制器 |
|
||||
| 48 | 上传视频 | POST | /content/video/upload | 根目录/video-content/视频控制器 |
|
||||
| 49 | 创建视频 | POST | /content/video | 根目录/video-content/视频控制器 |
|
||||
| 50 | 获取视频详情(公开接口) | GET | /content/video/public/{id} | 根目录/video-content/视频控制器 |
|
||||
| 51 | 获取视频列表(公开接口) | GET | /content/video/public/list | 根目录/video-content/视频控制器 |
|
||||
| 52 | 获取视频详情 | GET | /content/video/{id} | 根目录/video-content/视频控制器 |
|
||||
| 53 | 获取视频列表 | GET | /content/video/list | 根目录/video-content/视频控制器 |
|
||||
| 54 | 更新视频信息 | PUT | /content/video | 根目录/video-content/视频控制器 |
|
||||
| 55 | 删除视频 | DELETE | /content/video/{id} | 根目录/video-content/视频控制器 |
|
||||
| 56 | 点赞视频 | POST | /content/video/like/{videoId} | 根目录/video-content/视频控制器 |
|
||||
| 57 | 取消点赞 | DELETE | /content/video/like/{videoId} | 根目录/video-content/视频控制器 |
|
||||
| 58 | 投币 | POST | /content/video/coin/{videoId} | 根目录/video-content/视频控制器 |
|
||||
| 59 | 收藏视频 | POST | /content/video/favorite | 根目录/video-content/视频控制器 |
|
||||
| 60 | 取消收藏 | DELETE | /content/video/favorite/{videoId} | 根目录/video-content/视频控制器 |
|
||||
| 61 | 分享视频 | POST | /content/video/share/{videoId} | 根目录/video-content/视频控制器 |
|
||||
| 62 | 播放记录 | POST | /content/video/play | 根目录/video-content/视频控制器 |
|
||||
| 63 | 获取用户视频列表 | GET | /content/video/user/{userId} | 根目录/video-content/视频控制器 |
|
||||
| 64 | 视频审核 | POST | /content/video/review/{videoId} | 根目录/video-content/视频控制器 |
|
||||
| 65 | 增加视频评论数量 | POST | /content/video/count/comment/{videoId}/{count} | 根目录/video-content/视频控制器 |
|
||||
| 66 | 发送弹幕 | POST | /content/danmaku | 根目录/video-content/弹幕控制器 |
|
||||
| 67 | 获取视频指定时间段的弹幕 | GET | /content/danmaku/time | 根目录/video-content/弹幕控制器 |
|
||||
| 68 | 获取视频所有弹幕 | GET | /content/danmaku/all/{videoId} | 根目录/video-content/弹幕控制器 |
|
||||
| 69 | 获取分类树 | GET | /content/category/tree | 根目录/video-content/分类控制器 |
|
||||
| 70 | 获取分类列表 | GET | /content/category/list | 根目录/video-content/分类控制器 |
|
||||
| 71 | 添加分类 | POST | /content/category | 根目录/video-content/分类控制器 |
|
||||
| 72 | 更新分类 | PUT | /content/category | 根目录/video-content/分类控制器 |
|
||||
| 73 | 删除分类 | DELETE | /content/category/{id} | 根目录/video-content/分类控制器 |
|
||||
| 74 | 获取用户收藏夹列表 | GET | /content/favorite/list | 根目录/video-content/收藏夹控制器 |
|
||||
| 75 | 创建收藏夹 | POST | /content/favorite | 根目录/video-content/收藏夹控制器 |
|
||||
| 76 | 更新收藏夹 | PUT | /content/favorite | 根目录/video-content/收藏夹控制器 |
|
||||
| 77 | 删除收藏夹 | DELETE | /content/favorite/{id} | 根目录/video-content/收藏夹控制器 |
|
||||
| 78 | 获取收藏夹中的视频 | GET | /content/favorite/{favoriteId}/videos | 根目录/video-content/收藏夹控制器 |
|
||||
| 79 | 获取视频每日统计 | GET | /content/stat/daily/{videoId} | 根目录/video-content/视频统计控制器 |
|
||||
| 80 | 获取视频播放趋势(按小时) | GET | /content/stat/play/trend/{videoId} | 根目录/video-content/视频统计控制器 |
|
||||
| 81 | 获取视频互动统计 | GET | /content/stat/interaction/{videoId} | 根目录/video-content/视频统计控制器 |
|
||||
| 82 | 获取视频列表－管理接口 | GET | /content/video/admin/list | 根目录/video-content/视频管理控制器－供管理后台调用 |
|
||||
| 83 | 获取视频详情－管理接口 | GET | /content/video/admin/{videoId} | 根目录/video-content/视频管理控制器－供管理后台调用 |
|
||||
| 84 | 审核视频－管理接口 | POST | /content/video/admin/review/{videoId} | 根目录/video-content/视频管理控制器－供管理后台调用 |
|
||||
| 85 | 下架视频－管理接口 | PUT | /content/video/admin/disable/{videoId} | 根目录/video-content/视频管理控制器－供管理后台调用 |
|
||||
| 86 | 获取视频统计信息－管理接口 | GET | /content/video/admin/stats | 根目录/video-content/视频管理控制器－供管理后台调用 |
|
||||
| 87 | 获取分类列表－管理接口 | GET | /content/category/admin/list | 根目录/video-content/分类管理控制器－供管理后台调用 |
|
||||
| 88 | 添加分类－管理接口 | POST | /content/category/admin | 根目录/video-content/分类管理控制器－供管理后台调用 |
|
||||
| 89 | 更新分类－管理接口 | PUT | /content/category/admin | 根目录/video-content/分类管理控制器－供管理后台调用 |
|
||||
| 90 | 删除分类－管理接口 | DELETE | /content/category/admin/{categoryId} | 根目录/video-content/分类管理控制器－供管理后台调用 |
|
||||
| 91 | 获取首页推荐 | GET | /recommend/home | 根目录/video-recommend/推荐控制器 |
|
||||
| 92 | 获取热门推荐 | GET | /recommend/hot | 根目录/video-recommend/推荐控制器 |
|
||||
| 93 | 获取相似视频推荐 | GET | /recommend/similar/{videoId} | 根目录/video-recommend/推荐控制器 |
|
||||
| 94 | 获取标签视频推荐 | GET | /recommend/tag/{tagId} | 根目录/video-recommend/推荐控制器 |
|
||||
| 95 | 记录用户行为 | POST | /recommend/behavior | 根目录/video-recommend/推荐控制器 |
|
||||
| 96 | 更新用户兴趣 | POST | /recommend/interest/update | 根目录/video-recommend/推荐控制器 |
|
||||
| 97 | 添加回复 | POST | /comment/reply | 根目录/video-comment/回复控制器 |
|
||||
| 98 | 获取评论的回复列表(公开接口) | GET | /comment/reply/public/list/{commentId} | 根目录/video-comment/回复控制器 |
|
||||
| 99 | 获取评论的热门回复(公开接口) | GET | /comment/reply/public/hot/{commentId} | 根目录/video-comment/回复控制器 |
|
||||
| 100 | 删除回复 | DELETE | /comment/reply/{id} | 根目录/video-comment/回复控制器 |
|
||||
| 101 | 点赞回复 | POST | /comment/reply/like/{id} | 根目录/video-comment/回复控制器 |
|
||||
| 102 | 取消点赞回复 | DELETE | /comment/reply/like/{id} | 根目录/video-comment/回复控制器 |
|
||||
| 103 | 添加评论 | POST | /comment | 根目录/video-comment/评论控制器 |
|
||||
| 104 | 获取评论列表(公开接口) | GET | /comment/public/list | 根目录/video-comment/评论控制器 |
|
||||
| 105 | 获取评论详情(公开接口) | GET | /comment/public/detail/{id} | 根目录/video-comment/评论控制器 |
|
||||
| 106 | 删除评论 | DELETE | /comment/{id} | 根目录/video-comment/评论控制器 |
|
||||
| 107 | 点赞评论 | POST | /comment/like/{id} | 根目录/video-comment/评论控制器 |
|
||||
| 108 | 取消点赞评论 | DELETE | /comment/like/{id} | 根目录/video-comment/评论控制器 |
|
||||
| 109 | 置顶评论 | POST | /comment/top/{id} | 根目录/video-comment/评论控制器 |
|
||||
| 110 | 取消置顶评论 | DELETE | /comment/top/{id} | 根目录/video-comment/评论控制器 |
|
||||
| 111 | 获取评论统计信息(公开接口) | GET | /comment/public/stat/{videoId} | 根目录/video-comment/评论控制器 |
|
||||
| 112 | 获取评论列表－管理接口 | GET | /comment/admin/list | 根目录/video-comment/评论管理控制器－供管理后台调用 |
|
||||
| 113 | 获取评论详情－管理接口 | GET | /comment/admin/{commentId} | 根目录/video-comment/评论管理控制器－供管理后台调用 |
|
||||
| 114 | 删除评论－管理接口 | DELETE | /comment/admin/{commentId} | 根目录/video-comment/评论管理控制器－供管理后台调用 |
|
||||
| 115 | 获取评论统计信息－管理接口 | GET | /comment/admin/stats | 根目录/video-comment/评论管理控制器－供管理后台调用 |
|
||||
| 116 | 获取验证码 | GET | /admin/auth/captcha | 根目录/video-admin/认证控制器 |
|
||||
| 117 | 登录 | POST | /admin/auth/login | 根目录/video-admin/认证控制器 |
|
||||
| 118 | 登出 | POST | /admin/auth/logout | 根目录/video-admin/认证控制器 |
|
||||
| 119 | 获取当前用户信息 | GET | /admin/auth/info | 根目录/video-admin/认证控制器 |
|
||||
| 120 | 获取管理员列表 | GET | /admin/user/list | 根目录/video-admin/管理员控制器 |
|
||||
| 121 | 获取管理员详情 | GET | /admin/user/{id} | 根目录/video-admin/管理员控制器 |
|
||||
| 122 | 添加管理员 | POST | /admin/user | 根目录/video-admin/管理员控制器 |
|
||||
| 123 | 更新管理员 | PUT | /admin/user | 根目录/video-admin/管理员控制器 |
|
||||
| 124 | 删除管理员 | DELETE | /admin/user/{id} | 根目录/video-admin/管理员控制器 |
|
||||
| 125 | 启用/禁用管理员 | PUT | /admin/user/{id}/status/{status} | 根目录/video-admin/管理员控制器 |
|
||||
| 126 | 重置密码 | PUT | /admin/user/{id}/reset-password | 根目录/video-admin/管理员控制器 |
|
||||
| 127 | 获取用户列表 | GET | /admin/platform/user/list | 根目录/video-admin/用户管理控制器 |
|
||||
| 128 | 获取用户详情 | GET | /admin/platform/user/{userId} | 根目录/video-admin/用户管理控制器 |
|
||||
| 129 | 禁用/启用用户 | PUT | /admin/platform/user/{userId}/status/{status} | 根目录/video-admin/用户管理控制器 |
|
||||
| 130 | 重置用户密码 | PUT | /admin/platform/user/{userId}/reset-password | 根目录/video-admin/用户管理控制器 |
|
||||
| 131 | 获取视频列表 | GET | /admin/platform/content/video/list | 根目录/video-admin/内容管理控制器 |
|
||||
| 132 | 获取视频详情 | GET | /admin/platform/content/video/{videoId} | 根目录/video-admin/内容管理控制器 |
|
||||
| 133 | 审核视频 | POST | /admin/platform/content/video/review/{videoId} | 根目录/video-admin/内容管理控制器 |
|
||||
| 134 | 下架视频 | PUT | /admin/platform/content/video/disable/{videoId} | 根目录/video-admin/内容管理控制器 |
|
||||
| 135 | 获取分类列表 | GET | /admin/platform/content/category/list | 根目录/video-admin/内容管理控制器 |
|
||||
| 136 | 添加分类 | POST | /admin/platform/content/category | 根目录/video-admin/内容管理控制器 |
|
||||
| 137 | 更新分类 | PUT | /admin/platform/content/category | 根目录/video-admin/内容管理控制器 |
|
||||
| 138 | 删除分类 | DELETE | /admin/platform/content/category/{categoryId} | 根目录/video-admin/内容管理控制器 |
|
||||
接口以 `backend/*/src/main/java/**/controller/*Controller.java` 中的 Spring MVC 注解为唯一权威来源。此前的逐条静态清单与代码已发生偏差，现改为维护当前 Controller 路由索引，避免遗漏新增接口或保留已删除接口。
|
||||
|
||||
所有客户端业务请求默认经 `video-gateway:9000` 访问；以下为网关后的路径前缀。
|
||||
|
||||
| 服务 | Controller | 路由前缀 |
|
||||
| --- | --- | --- |
|
||||
| 认证 | `AuthController` / `AdminAuthController` | `/auth` / `/auth/admin` |
|
||||
| 用户 | `UserProfileController` / `UserFollowController` / `UserMessageController` / `UserNotificationController` / `UserSettingController` / `AdminUserController` | `/user/profile`、`/user/follow`、`/user/message`、`/user/notification`、`/user/setting`、`/user/profile/admin` |
|
||||
| 内容 | `VideoController` / `CategoryController` / `TagController` / `FavoriteController` / `DanmakuController` / `VideoStatController` | `/content/video`、`/content/category`、`/content/tag`、`/content/favorite`、`/content/danmaku`、`/content/stat` |
|
||||
| 内容管理 | `AdminVideoController` / `AdminCategoryController` | `/content/video/admin` / `/content/category/admin` |
|
||||
| 评论 | `CommentController` / `ReplyController` / `AdminCommentController` | `/comment` / `/comment/reply` / `/comment/admin` |
|
||||
| 推荐 | `RecommendController` | `/recommend` |
|
||||
| 管理端 | `AuthController` / `AdminUserController` / `AdminRoleController` / `UserManageController` / `ContentManageController` / `CommentManageController` / `DashboardController` | `/admin/auth`、`/admin/user`、`/admin/role`、`/admin/platform/user`、`/admin/platform/content`、`/admin/platform/comment`、`/admin/dashboard` |
|
||||
|
||||
## 主要公开路由
|
||||
|
||||
网关白名单由 `video-gateway.yaml` 和 `GATEWAY_IGNORE_URLS` 配置控制，当前包含登录/注册/验证码/令牌刷新、公开视频与分类/标签/弹幕/统计、公开用户主页与搜索、公开评论回复以及推荐接口等。白名单属于安全配置，变更时必须同步审查网关过滤器和 Nacos 配置。
|
||||
|
||||
## 维护方式
|
||||
|
||||
新增或修改接口时，应同时更新 Controller 注释、DTO 校验和前端 `src/api` 调用；再检查网关公开路由是否需要调整。接口鉴权、参数和响应字段请直接查阅对应 Controller、DTO/VO 与 `Result`，不要依赖旧版本的 curl 示例。
|
||||
|
||||
Reference in New Issue
Block a user