Toys-A
30c17f01e9
- 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
2.3 KiB
2.3 KiB
HAOVP 接口索引
接口以 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 示例。