Appearance
接口概览
后台管理相关接口主要面向前端控制台(movieappAdmin-frontend),所有请求默认以 / 作为根路径。API 采用 JWT 认证,并结合 RBAC 权限控制访问。
基础信息
- 域名:如
https://admin-api.movie.example,本地调试为http://127.0.0.1:3000。 - 鉴权方式:
- 调用
POST /auth/login获取accessToken、refreshToken。 - 之后请求在 Header 中携带
Authorization: Bearer <accessToken>。 - 若返回 401,可用
GET /auth/refresh/token刷新。
- 调用
- 响应结构:统一区分成功/失败。
json
{
"code": 0,
"message": "OK",
"data": {},
"originUrl": "/vod"
}当接口返回原始字符串或二进制(如上传、验证码)时,会跳过包装。
权限模型
后端为受 JwtGuard + RoleGuard 双层保护的资源提供访问控制:
permission表记录菜单/按钮权限。role_permission关联角色与权限。- 登录后端时,用户当前角色决定前端可见菜单与接口访问权限。
在新增接口前,需要:
- 定义 Controller 并声明
@UseGuards(JwtGuard, RoleGuard)(若开放接口可只保留JwtGuard)。 - 在
permission表或后台“资源管理”中登记新的权限码。 - 将权限授权给对应角色,保证前端能拉取到。
错误响应
code | HTTP | 说明 |
|---|---|---|
10003 | 400 | 验证码错误、密码错误等业务异常。 |
10004 | 400 | 旧密码校验失败(修改密码)。 |
10005 | 401 | Token 失效或角色切换失败。 |
10006 | 403 | 无访问权限。 |
错误格式示例:
json
{
"code": 10006,
"message": "Forbidden",
"timestamp": "2025-10-16T13:07:31.123Z",
"path": "/vod/updateVodLevelByVodId"
}模块索引
| 模块 | 路径前缀 | 说明 |
|---|---|---|
AuthController | /auth | 登录、刷新 token、验证码、登出等安全相关接口。 |
VodController | /vod | 视频内容管理(列表、推荐等级、删除等)。 |
AppManagementController | /appConfig | App 配置的读取与保存。 |
UploadController | /upload | 图片/文件上传。 |
| 其他模块 | /permission、/role、/user | 与通用权限系统相关,当前文档暂不展开。 |
文档中的接口以 JSON 为主,若无特殊说明均需加入
AuthorizationHeader。