Skip to content

接口概览

后台管理相关接口主要面向前端控制台(movieappAdmin-frontend),所有请求默认以 / 作为根路径。API 采用 JWT 认证,并结合 RBAC 权限控制访问。

基础信息

  • 域名:如 https://admin-api.movie.example,本地调试为 http://127.0.0.1:3000
  • 鉴权方式
    1. 调用 POST /auth/login 获取 accessTokenrefreshToken
    2. 之后请求在 Header 中携带 Authorization: Bearer <accessToken>
    3. 若返回 401,可用 GET /auth/refresh/token 刷新。
  • 响应结构:统一区分成功/失败。
json
{
  "code": 0,
  "message": "OK",
  "data": {},
  "originUrl": "/vod"
}

当接口返回原始字符串或二进制(如上传、验证码)时,会跳过包装。

权限模型

后端为受 JwtGuard + RoleGuard 双层保护的资源提供访问控制:

  • permission 表记录菜单/按钮权限。
  • role_permission 关联角色与权限。
  • 登录后端时,用户当前角色决定前端可见菜单与接口访问权限。

在新增接口前,需要:

  1. 定义 Controller 并声明 @UseGuards(JwtGuard, RoleGuard)(若开放接口可只保留 JwtGuard)。
  2. permission 表或后台“资源管理”中登记新的权限码。
  3. 将权限授权给对应角色,保证前端能拉取到。

错误响应

codeHTTP说明
10003400验证码错误、密码错误等业务异常。
10004400旧密码校验失败(修改密码)。
10005401Token 失效或角色切换失败。
10006403无访问权限。

错误格式示例:

json
{
  "code": 10006,
  "message": "Forbidden",
  "timestamp": "2025-10-16T13:07:31.123Z",
  "path": "/vod/updateVodLevelByVodId"
}

模块索引

模块路径前缀说明
AuthController/auth登录、刷新 token、验证码、登出等安全相关接口。
VodController/vod视频内容管理(列表、推荐等级、删除等)。
AppManagementController/appConfigApp 配置的读取与保存。
UploadController/upload图片/文件上传。
其他模块/permission/role/user与通用权限系统相关,当前文档暂不展开。

文档中的接口以 JSON 为主,若无特殊说明均需加入 Authorization Header。