myblog

Appearance

商品分类管理控制器文档 ​

接口信息 ​

  • 控制器类: MallItemCategoryController
  • 包路径: com.qisheng.mall.web
  • 功能描述: 负责处理商城商品分类的增删改查操作

类图 ​

uml diagram

接口列表 ​

1. 获取小程序商品分类 ​

  • 请求方式: GET
  • URL: /{merchantId}/mp_mall_item_category
  • 功能: 获取小程序商品分类列表
  • 参数:
    • merchantId: 商户ID (路径参数)
    • type: 分类类型 (查询参数，可选)
    • shopId: 门店ID (查询参数，可选)
  • 返回: ObjectResponse<List<JSONObject>>
  • 示例:
http
GET /82/mp_mall_item_category?type=SERVICE&shopId=123

2. 获取商品分类 ​

  • 请求方式: GET
  • URL: /{merchantId}/mall_item_category
  • 功能: 获取商品分类列表
  • 参数:
    • merchantId: 商户ID (路径参数)
  • 返回: ObjectResponse<List<MallItemCategoryVo>>
  • 示例:
http
GET /82/mall_item_category

3. 获取积分商品分类 ​

  • 请求方式: GET
  • URL: /{merchantId}/point_item_category
  • 功能: 获取分类下积分商品数量
  • 参数:
    • merchantId: 商户ID (路径参数)
    • request: 分类请求对象 (查询参数)
  • 返回: ObjectResponse
  • 示例:
http
GET /82/point_item_category

4. 添加商品分类 ​

  • 请求方式: POST
  • URL: /{merchantId}/mall_item_category
  • 功能: 创建新的商品分类
  • 参数:
    • merchantId: 商户ID (路径参数)
    • request: 商品分类请求对象 (请求体)
  • 返回: BaseResponse
  • 示例:
http
POST /82/mall_item_category
{
  "name": "护肤品",
  "type": "GOODS",
  "status": "NORMAL",
  "seqNo": 1
}

5. 更新商品分类 ​

  • 请求方式: PUT 或 PATCH
  • URL: /{merchantId}/mall_item_category/{id}
  • 功能: 更新商品分类信息
  • 参数:
    • merchantId: 商户ID (路径参数)
    • id: 分类ID (路径参数)
    • request: 商品分类请求对象 (请求体)
  • 返回: BaseResponse
  • 示例:
http
PATCH /82/mall_item_category/123
{
  "name": "护肤精品",
  "status": "NORMAL",
  "seqNo": 2
}

6. 删除商品分类 ​

  • 请求方式: DELETE
  • URL: /{merchantId}/mall_item_category/{id}
  • 功能: 删除商品分类
  • 参数:
    • merchantId: 商户ID (路径参数)
    • id: 分类ID (路径参数)
  • 返回: BaseResponse
  • 示例:
http
DELETE /82/mall_item_category/123

7. 根据商户ID和名称获取商品分类 ​

  • 请求方式: POST
  • URL: /{merchantId}/mall_item_category_by_name
  • 功能: 根据商户ID和名称获取商品分类，用于插入前检查
  • 参数:
    • merchantId: 商户ID (路径参数)
    • req: 商品分类查询请求对象 (请求体)
  • 返回: ObjectResponse
  • 示例:
http
POST /82/mall_item_category_by_name
{
  "name": "护肤品",
  "type": "GOODS"
}

8. 获取商品分类 ​

  • 请求方式: GET
  • URL: /{merchantId}/category
  • 功能: 获取商品分类列表
  • 参数:
    • merchantId: 商户ID (路径参数)
    • req: 分类请求对象 (查询参数)
  • 返回: PageResponse
  • 示例:
http
GET /82/category?pageNum=1&pageSize=20

9. 更新商品分类排序 ​

  • 请求方式: PATCH
  • URL: /{merchantId}/category
  • 功能: 更新商品分类排序
  • 参数:
    • merchantId: 商户ID (路径参数)
    • req: 分类请求对象 (请求体)
  • 返回: BaseResponse
  • 示例:
http
PATCH /82/category
{
  "id": 123,
  "seqNo": 3
}

调用流程 ​

1. 获取商品分类流程 ​

uml diagram

2. 添加商品分类流程 ​

uml diagram

主要功能说明 ​

商品分类类型 ​

  • SERVICE: 服务类
  • GOODS: 卖品类

商品分类状态 ​

  • NORMAL: 正常
  • DISABLED: 已停用
  • DELETED: 已删除

元数据刷新 ​

  • 使用 @MetaTsFresh 注解标记需要刷新元数据的方法，模块为 MetaType.Mall.META_MALL_ITEM_CATEGORY

注意事项 ​

1. 数据表说明 ​

  • T_MALL_ITEM_CATEGORY: 商品分类表，存储商品分类的基本信息

2. 权限控制 ​

  • 商户ID: 通过商户ID进行权限控制，只能操作自己商户的商品分类

3. 业务逻辑 ​

  • 分类名称唯一性: 同一商户下同一类型的分类名称不能重复
  • 分类排序: 通过 seqNo 字段控制分类的排序
  • 分类状态: 通过 status 字段控制分类的状态

4. 分类统计 ​

  • itemCount: 分类下商品总数量
  • onCount: 分类下上架商品数量
  • offCount: 分类下下架商品数量

5. 参数验证 ​

  • 添加分类时，必须提供分类名称和类型
  • 查询分类时，可以根据类型和状态进行筛选

6. 小程序分类 ​

  • 小程序分类接口返回的是 JSONObject 列表，包含更多的展示信息
  • 可以根据门店ID筛选特定门店可用的分类