主题
后台接口说明
版本:v3.0 | 最后更新:2026-07 | 文档状态:已同步代码
按运营管理模块,说明后台管理系统每个功能对应的接口。
路径已与代码逐一核对(
mall-admin全部 39 个 Controller / 222 个端点),下表均为真实端点。
认证与安全
登录
- 用途:管理员登录后台
- 接口:
POST /api/admin/login - 参数:用户名、密码、验证码、验证码 ID
- 返回:Token + 管理员信息
- 安全机制:验证码 5 分钟有效、连续 5 次失败锁定 30 分钟
获取当前用户信息
- 用途:登录后获取当前管理员信息
- 接口:
GET /api/admin/info - 返回:用户名、头像、角色列表、菜单列表
获取图形验证码
- 接口:
GET /api/admin/captcha
商品管理
所有接口前缀:
/api/product
商品列表
- 用途:查看所有商品,支持搜索和筛选
- 接口:
GET /api/product/list - 参数:关键词、分类、品牌、页码
- 返回:商品列表(含图片、价格、库存、状态)
创建商品
- 用途:上架新商品
- 接口:
POST /api/product/create - 参数:商品信息(名称、分类、品牌、价格、库存、规格属性、SKU 列表等)
编辑商品
- 用途:修改已有商品信息
- 接口:
POST /api/product/update/{id}
删除商品
- 用途:下架并删除商品
- 接口:
POST /api/product/delete/{id}
商品分类
| 操作 | 接口 | 说明 |
|---|---|---|
| 分类树 | GET /api/productCategory/tree | 返回完整三级分类树(推荐使用) |
| 按父级查询 | GET /api/productCategory/list/{parentId} | 最多三级 |
| 带子级列表 | GET /api/productCategory/list/withChildren | |
| 分类详情 | GET /api/productCategory/{id} | |
| 新增分类 | POST /api/productCategory/create | |
| 编辑分类 | POST /api/productCategory/update/{id} | |
| 删除分类 | POST /api/productCategory/delete/{id} | 有子分类或关联商品时拒绝删除 |
| 显示状态 | POST /api/productCategory/update/showStatus | |
| 导航状态 | POST /api/productCategory/update/navStatus |
品牌管理
| 操作 | 接口 | 说明 |
|---|---|---|
| 品牌列表 | GET /api/brand/list | 分页查询 |
| 新增品牌 | POST /api/brand/create | |
| 编辑品牌 | POST /api/brand/update/{id} | |
| 删除品牌 | POST /api/brand/delete/{id} | 有关联商品时拒绝删除 |
属性管理
注意:实际前缀是
/api/productAttribute(不是productAttr)
| 操作 | 接口 | 说明 |
|---|---|---|
| 属性列表 | GET /api/productAttribute/list/{cid} | 按属性分类 ID 查询 |
| 属性详情 | GET /api/productAttribute/{id} | |
| 按商品分类查属性 | GET /api/productAttribute/attrInfo/{productCategoryId} | |
| 新增属性 | POST /api/productAttribute/create | |
| 编辑属性 | POST /api/productAttribute/update/{id} | |
| 批量删除属性 | POST /api/productAttribute/delete | |
| 属性分类列表 | GET /api/productAttribute/category/list | |
| 属性分类详情 | GET /api/productAttribute/category/{id} | |
| 新增属性分类 | POST /api/productAttribute/category/create | |
| 编辑属性分类 | POST /api/productAttribute/category/update/{id} | |
| 删除属性分类 | POST /api/productAttribute/category/delete/{id} |
SKU 库存
| 操作 | 接口 | 说明 |
|---|---|---|
| SKU 列表 | GET /api/sku/{pid} | 按商品 ID 查询 SKU |
| 批量更新 SKU | POST /api/sku/update/{pid} |
运费模板
| 操作 | 接口 | 说明 |
|---|---|---|
| 模板列表 | GET /api/feightTemplate/list | |
| 模板详情 | GET /api/feightTemplate/{id} | |
| 新增模板 | POST /api/feightTemplate/create | |
| 编辑模板 | POST /api/feightTemplate/update/{id} | |
| 删除模板 | POST /api/feightTemplate/delete/{id} |
文件上传
| 操作 | 接口 | 说明 |
|---|---|---|
| MinIO 上传 | POST /api/minio/upload | 表单字段 file,当前前端默认走此路径 |
| MinIO 删除 | POST /api/minio/delete | |
| OSS 直传凭证 | GET /api/aliyun/oss/policy | 需 VITE_USE_OSS=true 才启用 |
✅ 上传链路已修复:前端
.env的VITE_MINIO_UPLOAD_URL现为/api/minio/upload,与上表一致,经 Vite 的/api代理转发到 mall-admin:8080。此前误配为/minio/upload(不匹配任何代理)导致 404。
订单管理
订单列表
- 用途:查看所有订单,支持日期范围搜索
- 接口:
GET /api/order/list - 参数:订单号、收货人、日期范围、订单状态、页码
- 返回:订单列表(含商品信息、收货人、金额、状态)
订单详情
- 用途:查看某个订单的完整信息
- 接口:
GET /api/order/{id} - 返回:商品信息、收货地址、金额明细、操作历史
订单操作
| 操作 | 接口 | 说明 |
|---|---|---|
| 发货 | POST /api/order/update/delivery | 物流公司(8家预置)+ 运单号,自动记录操作日志 |
| 关闭订单 | POST /api/order/update/close | |
| 修改收货人 | POST /api/order/update/receiverInfo | |
| 修改费用 | POST /api/order/update/moneyInfo | |
| 备注订单 | POST /api/order/update/note | |
| 删除订单 | POST /api/order/delete | |
| 导出订单 | GET /api/order/export |
发货地址库
| 操作 | 接口 | 说明 |
|---|---|---|
| 地址列表 | GET /api/companyAddress/list |
订单设置
| 操作 | 接口 | 说明 |
|---|---|---|
| 查询设置 | GET /api/orderSetting/{id} | |
| 修改设置 | POST /api/orderSetting/update/{id} | 超时关闭、自动收货等 |
退货申请
| 操作 | 接口 | 说明 |
|---|---|---|
| 退货列表 | GET /api/returnApply/list | 按状态筛选 |
| 退货详情 | GET /api/returnApply/{id} | |
| 审核(同意/拒绝/确认收货) | POST /api/returnApply/update/status/{id} | 同一端点,按状态参数区分 |
| 统计 | GET /api/returnApply/stats | |
| 删除 | POST /api/returnApply/delete |
退货原因
| 操作 | 接口 | 说明 |
|---|---|---|
| 原因列表 | GET /api/returnReason/listAll | |
| 原因详情 | GET /api/returnReason/{id} | |
| 新增原因 | POST /api/returnReason/create | |
| 编辑原因 | POST /api/returnReason/update/{id} | |
| 启用/禁用 | POST /api/returnReason/update/status | |
| 批量删除 | POST /api/returnReason/delete |
促销管理
优惠券
| 操作 | 接口 | 说明 |
|---|---|---|
| 优惠券列表 | GET /api/coupon/list | |
| 新增优惠券 | POST /api/coupon/create | 设置面额、门槛、有效期 |
| 编辑优惠券 | POST /api/coupon/update/{id} | |
| 删除优惠券 | POST /api/coupon/delete/{id} | |
| 领取记录 | GET /api/couponHistory/list | 独立 Controller,不是 /api/coupon/history |
秒杀活动
| 操作 | 接口 | 说明 |
|---|---|---|
| 活动列表 | GET /api/flash/list | |
| 新增活动 | POST /api/flash/create | |
| 场次列表 | GET /api/flashSession/list | 独立 Controller |
| 秒杀商品关系 | GET /api/flashProductRelation/list | 不是 /api/flash/product |
| 新增秒杀商品 | POST /api/flashProductRelation/create | 设置秒杀价和限量 |
推荐管理
| 模块 | 列表接口 | 说明 |
|---|---|---|
| 新品推荐 | GET /api/home/newProduct/list | 首页新品推荐 |
| 人气推荐 | GET /api/home/recommendProduct/list | 首页人气推荐 |
| 广告位 | GET /api/home/advertise/list | 首页轮播广告 |
| 品牌推荐 | GET /api/home/brand/list | 首页品牌展示 |
| 专题推荐 | GET /api/home/recommendSubject/list | 首页专题入口 |
⚠️ 推荐类接口统一带
/home/段,不是/api/newProduct、/api/advertise这种写法。状态与排序更新端点为/update/recommendStatus和/update/sort/{id}。
内容管理
专题管理
| 操作 | 接口 | 说明 |
|---|---|---|
| 专题列表 | GET /api/subject/list | |
| 新增专题 | POST /api/subject/create | |
| 编辑专题 | POST /api/subject/update/{id} | |
| 删除专题 | POST /api/subject/delete/{id} |
话题管理
| 操作 | 接口 | 说明 |
|---|---|---|
| 话题列表 | GET /api/topic/list | |
| 新增/编辑/删除 | /api/topic/* | 同上模式 |
优选专区
| 操作 | 接口 | 说明 |
|---|---|---|
| 专区列表 | GET /api/preferenceArea/list | |
| 新增/编辑/删除 | /api/preferenceArea/* | 同上模式 |
帮助管理
| 操作 | 接口 | 说明 |
|---|---|---|
| 帮助列表 | GET /api/help/list | |
| 帮助分类列表 | GET /api/help/category/list | |
| 帮助分类全量 | GET /api/help/category/listAll |
举报处理
| 操作 | 接口 | 说明 |
|---|---|---|
| 举报列表 | GET /api/memberReport/list | |
| 举报统计 | GET /api/memberReport/stats | |
| 处理举报 | POST /api/memberReport/handle/{id} | |
| 删除 | POST /api/memberReport/delete/{id} |
会员管理
会员列表
- 用途:查看所有注册会员
- 接口:
GET /api/member/list - 参数:用户名、手机号、会员等级、状态
- 返回:会员列表(含积分、成长值、等级)
会员详情与操作
| 操作 | 接口 | 说明 |
|---|---|---|
| 会员详情 | GET /api/member/{id} | |
| 登录日志 | GET /api/member/{id}/lastLogin | |
| 状态变更日志 | GET /api/member/{id}/statusLogs | |
| 调整积分 | POST /api/member/update/integration/{id} | |
| 调整成长值 | POST /api/member/update/growth/{id} | 自动触发等级升降级检查 |
| 启用/禁用 | POST /api/member/update/status/{id} | |
| 导出会员 | GET /api/member/export |
⚠️ 会员更新接口必须带调整类型段(
integration/growth/status),不存在POST /api/member/update这一端点。
会员等级配置
| 操作 | 接口 | 说明 |
|---|---|---|
| 等级列表 | GET /api/memberLevel/list | |
| 新增等级 | POST /api/memberLevel/create | 配置成长值阈值 |
| 编辑等级 | POST /api/memberLevel/update/{id} | |
| 删除等级 | POST /api/memberLevel/delete/{id} |
权限管理
管理员
| 操作 | 接口 | 说明 |
|---|---|---|
| 管理员列表 | GET /api/admin/list | |
| 新增管理员 | POST /api/admin/create | |
| 编辑管理员 | POST /api/admin/update/{id} | |
| 启用/禁用 | POST /api/admin/updateStatus/{id} | 禁用时清除 Token |
| 分配角色 | POST /api/admin/role/update |
角色
| 操作 | 接口 | 说明 |
|---|---|---|
| 角色列表 | GET /api/role/list | |
| 新增角色 | POST /api/role/create | |
| 编辑角色 | POST /api/role/update/{id} | |
| 删除角色 | POST /api/role/delete | 有管理员关联时拒绝删除 |
| 分配菜单 | POST /api/role/allocMenu | |
| 分配资源 | POST /api/role/allocResource |
菜单 & 资源
| 操作 | 接口 | 说明 |
|---|---|---|
| 菜单树(按父级) | GET /api/menu/list/{parentId} | 带路径参数 |
| 菜单树(完整) | GET /api/menu/treeList | 推荐使用 |
| 新增菜单 | POST /api/menu/create | |
| 编辑菜单 | POST /api/menu/update/{id} | |
| 显隐切换 | POST /api/menu/updateHidden/{id} | |
| 资源列表 | GET /api/resource/list | 支持分类筛选 |
| 新增资源 | POST /api/resource/create | |
| 资源分类列表 | GET /api/resourceCategory/list |
权限审计日志
| 操作 | 接口 | 说明 |
|---|---|---|
| 审计日志列表 | GET /api/permissionLog/list | 记录管理员/角色/菜单/资源的变更 |
仪表盘
| 操作 | 接口 | 说明 |
|---|---|---|
| 统计数据 | GET /api/admin/stats | 今日订单数、本月订单数、商品总数、最近 5 条订单 |