feat：【mall 商城】API 风格调整

2025-10-08 11:17:22 +08:00
parent 4648f2023b
commit 5cdf1af39f
26 changed files with 399 additions and 731 deletions
--- a/apps/web-antd/src/api/mall/product/brand.ts
+++ b/apps/web-antd/src/api/mall/product/brand.ts
@@ -5,18 +5,12 @@ import { requestClient } from '#/api/request';
 export namespace MallBrandApi {
  /** 商品品牌 */
  export interface Brand {
-    /** 品牌编号 */
-    id?: number;
-    /** 品牌名称 */
-    name: string;
-    /** 品牌图片 */
-    picUrl: string;
-    /** 品牌排序 */
-    sort?: number;
-    /** 品牌描述 */
-    description?: string;
-    /** 开启状态 */
-    status: number;
+    id?: number; // 品牌编号
+    name: string; // 品牌名称
+    picUrl: string; // 品牌图片
+    sort?: number; // 品牌排序
+    description?: string; // 品牌描述
+    status: number; // 开启状态
  }
 }

--- a/apps/web-antd/src/api/mall/product/category.ts
+++ b/apps/web-antd/src/api/mall/product/category.ts
@@ -3,18 +3,12 @@ import { requestClient } from '#/api/request';
 export namespace MallCategoryApi {
  /** 产品分类 */
  export interface Category {
-    /** 分类编号 */
-    id?: number;
-    /** 父分类编号 */
-    parentId?: number;
-    /** 分类名称 */
-    name: string;
-    /** 移动端分类图 */
-    picUrl: string;
-    /** 分类排序 */
-    sort: number;
-    /** 开启状态 */
-    status: number;
+    id?: number; // 分类编号
+    parentId?: number; // 父分类编号
+    name: string; // 分类名称
+    picUrl: string; // 移动端分类图
+    sort: number; // 分类排序
+    status: number; // 开启状态
  }
 }

--- a/apps/web-antd/src/api/mall/product/comment.ts
+++ b/apps/web-antd/src/api/mall/product/comment.ts
@@ -4,47 +4,47 @@ import { requestClient } from '#/api/request';

 export namespace MallCommentApi {
  export interface Property {
-    propertyId: number;
-    propertyName: string;
-    valueId: number;
-    valueName: string;
+    propertyId: number; // 属性 ID
+    propertyName: string; // 属性名称
+    valueId: number; // 属性值 ID
+    valueName: string; // 属性值名称
  }
  /** 商品评论 */
  export interface Comment {
-    id: number;
-    userId: number;
-    userNickname: string;
-    userAvatar: string;
-    anonymous: boolean;
-    orderId: number;
-    orderItemId: number;
-    spuId: number;
-    spuName: string;
-    skuId: number;
-    visible: boolean;
-    scores: number;
-    descriptionScores: number;
-    benefitScores: number;
-    content: string;
-    picUrls: string[];
-    replyStatus: boolean;
-    replyUserId: number;
-    replyContent: string;
-    replyTime: Date;
-    createTime: Date;
-    skuProperties: Property[];
+    id: number; // 评论编号
+    userId: number; // 用户编号
+    userNickname: string; // 用户昵称
+    userAvatar: string; // 用户头像
+    anonymous: boolean; // 是否匿名
+    orderId: number; // 订单编号
+    orderItemId: number; // 订单项编号
+    spuId: number; // 商品SPU编号
+    spuName: string; // 商品名称
+    skuId: number; // 商品SKU编号
+    visible: boolean; // 是否可见
+    scores: number; // 总评分
+    descriptionScores: number; // 描述评分
+    benefitScores: number; // 服务评分
+    content: string; // 评论内容
+    picUrls: string[]; // 评论图片
+    replyStatus: boolean; // 是否回复
+    replyUserId: number; // 回复人编号
+    replyContent: string; // 回复内容
+    replyTime: Date; // 回复时间
+    createTime: Date; // 创建时间
+    skuProperties: Property[]; // SKU 属性数组
  }

  /** 评论可见性更新 */
  export interface CommentVisibleUpdate {
-    id: number;
-    visible: boolean;
+    id: number; // 评论编号
+    visible: boolean; // 是否可见
  }

  /** 评论回复 */
  export interface CommentReply {
-    id: number;
-    replyContent: string;
+    id: number; // 评论编号
+    replyContent: string; // 回复内容
  }
 }

--- a/apps/web-antd/src/api/mall/product/favorite.ts
+++ b/apps/web-antd/src/api/mall/product/favorite.ts
@@ -5,12 +5,9 @@ import { requestClient } from '#/api/request';
 export namespace MallFavoriteApi {
  /** 商品收藏 */
  export interface Favorite {
-    /** 收藏编号 */
-    id?: number;
-    /** 用户编号 */
-    userId?: string;
-    /** 商品 SPU 编号 */
-    spuId?: null | number;
+    id?: number; // 收藏编号
+    userId?: string; // 用户编号
+    spuId?: number; // 商品 SPU 编号
  }
 }

--- a/apps/web-antd/src/api/mall/product/history.ts
+++ b/apps/web-antd/src/api/mall/product/history.ts
@@ -5,21 +5,15 @@ import { requestClient } from '#/api/request';
 export namespace MallHistoryApi {
  /** 商品浏览记录 */
  export interface BrowseHistory {
-    /** 记录编号 */
-    id?: number;
-    /** 用户编号 */
-    userId?: number;
-    /** 商品 SPU 编号 */
-    spuId?: number;
-    /** 浏览时间 */
-    createTime?: Date;
+    id?: number; // 记录编号
+    userId?: number; // 用户编号
+    spuId?: number; // 商品 SPU 编号
+    createTime?: Date; // 浏览时间
  }
 }

 /**
 * 获得商品浏览记录分页
- *
- * @param params 请求参数
 */
 export function getBrowseHistoryPage(params: PageParam) {
  return requestClient.get<PageResult<MallHistoryApi.BrowseHistory>>(
--- a/apps/web-antd/src/api/mall/product/property.ts
+++ b/apps/web-antd/src/api/mall/product/property.ts
@@ -5,29 +5,22 @@ import { requestClient } from '#/api/request';
 export namespace MallPropertyApi {
  /** 商品属性 */
  export interface Property {
-    /** 属性编号 */
-    id?: number;
-    /** 名称 */
-    name: string;
-    /** 备注 */
-    remark?: string;
+    id?: number; // 属性编号
+    name: string; // 名称
+    remark?: string; // 备注
  }

  /** 属性值 */
  export interface PropertyValue {
-    /** 属性值编号 */
-    id?: number;
-    /** 属性项的编号 */
-    propertyId?: number;
-    /** 名称 */
-    name: string;
-    /** 备注 */
-    remark?: string;
+    id?: number; // 属性值编号
+    propertyId?: number; // 属性项的编号
+    name: string; // 名称
+    remark?: string; // 备注
  }

  /** 属性值查询参数 */
  export interface PropertyValueQuery extends PageParam {
-    propertyId?: number;
+    propertyId?: number; // 属性编号
  }
 }

--- a/apps/web-antd/src/api/mall/product/spu.ts
+++ b/apps/web-antd/src/api/mall/product/spu.ts
@@ -5,124 +5,73 @@ import { requestClient } from '#/api/request';
 export namespace MallSpuApi {
  /** 商品属性 */
  export interface Property {
-    /** 属性编号 */
-    propertyId?: number;
-    /** 属性名称 */
-    propertyName?: string;
-    /** 属性值编号 */
-    valueId?: number;
-    /** 属性值名称 */
-    valueName?: string;
+    propertyId?: number; // 属性编号
+    propertyName?: string; // 属性名称
+    valueId?: number; // 属性值编号
+    valueName?: string; // 属性值名称
  }

  /** 商品 SKU */
  export interface Sku {
-    /** 商品 SKU 编号 */
-    id?: number;
-    /** 商品 SKU 名称 */
-    name?: string;
-    /** SPU 编号 */
-    spuId?: number;
-    /** 属性数组 */
-    properties?: Property[];
-    /** 商品价格 */
-    price?: number | string;
-    /** 市场价 */
-    marketPrice?: number | string;
-    /** 成本价 */
-    costPrice?: number | string;
-    /** 商品条码 */
-    barCode?: string;
-    /** 图片地址 */
-    picUrl?: string;
-    /** 库存 */
-    stock?: number;
-    /** 商品重量，单位：kg 千克 */
-    weight?: number;
-    /** 商品体积，单位：m^3 平米 */
-    volume?: number;
-    /** 一级分销的佣金 */
-    firstBrokeragePrice?: number | string;
-    /** 二级分销的佣金 */
-    secondBrokeragePrice?: number | string;
-    /** 商品销量 */
-    salesCount?: number;
+    id?: number; // 商品 SKU 编号
+    name?: string; // 商品 SKU 名称
+    spuId?: number; // SPU 编号
+    properties?: Property[]; // 属性数组
+    price?: number | string; // 商品价格
+    marketPrice?: number | string; // 市场价
+    costPrice?: number | string; // 成本价
+    barCode?: string; // 商品条码
+    picUrl?: string; // 图片地址
+    stock?: number; // 库存
+    weight?: number; // 商品重量，单位：kg 千克
+    volume?: number; // 商品体积，单位：m^3 平米
+    firstBrokeragePrice?: number | string; // 一级分销的佣金
+    secondBrokeragePrice?: number | string; // 二级分销的佣金
+    salesCount?: number; // 商品销量
  }

  /** 优惠券模板 */
  export interface GiveCouponTemplate {
-    /** 优惠券编号 */
-    id?: number;
-    /** 优惠券名称 */
-    name?: string;
+    id?: number; // 优惠券编号
+    name?: string; // 优惠券名称
  }

  /** 商品 SPU */
  export interface Spu {
-    /** 商品编号 */
-    id?: number;
-    /** 商品名称 */
-    name?: string;
-    /** 商品分类 */
-    categoryId?: number;
-    /** 关键字 */
-    keyword?: string;
-    /** 单位 */
-    unit?: number | undefined;
-    /** 商品封面图 */
-    picUrl?: string;
-    /** 商品轮播图 */
-    sliderPicUrls?: string[];
-    /** 商品简介 */
-    introduction?: string;
-    /** 配送方式 */
-    deliveryTypes?: number[];
-    /** 运费模版 */
-    deliveryTemplateId?: number | undefined;
-    /** 商品品牌编号 */
-    brandId?: number;
-    /** 商品规格 */
-    specType?: boolean;
-    /** 分销类型 */
-    subCommissionType?: boolean;
-    /** sku数组 */
-    skus?: Sku[];
-    /** 商品详情 */
-    description?: string;
-    /** 商品排序 */
-    sort?: number;
-    /** 赠送积分 */
-    giveIntegral?: number;
-    /** 虚拟销量 */
-    virtualSalesCount?: number;
-    /** 商品价格 */
-    price?: number;
-    /** 商品拼团价格 */
-    combinationPrice?: number;
-    /** 商品秒杀价格 */
-    seckillPrice?: number;
-    /** 商品销量 */
-    salesCount?: number;
-    /** 市场价 */
-    marketPrice?: number;
-    /** 成本价 */
-    costPrice?: number;
-    /** 商品库存 */
-    stock?: number;
-    /** 商品创建时间 */
-    createTime?: Date;
-    /** 商品状态 */
-    status?: number;
-    /** 浏览量 */
-    browseCount?: number;
+    id?: number; // 商品编号
+    name?: string; // 商品名称
+    categoryId?: number; // 商品分类
+    keyword?: string; // 关键字
+    unit?: number; // 单位
+    picUrl?: string; // 商品封面图
+    sliderPicUrls?: string[]; // 商品轮播图
+    introduction?: string; // 商品简介
+    deliveryTypes?: number[]; // 配送方式
+    deliveryTemplateId?: number; // 运费模版
+    brandId?: number; // 商品品牌编号
+    specType?: boolean; // 商品规格
+    subCommissionType?: boolean; // 分销类型
+    skus?: Sku[]; // sku数组
+    description?: string; // 商品详情
+    sort?: number; // 商品排序
+    giveIntegral?: number; // 赠送积分
+    virtualSalesCount?: number; // 虚拟销量
+    price?: number; // 商品价格
+    combinationPrice?: number; // 商品拼团价格
+    seckillPrice?: number; // 商品秒杀价格
+    salesCount?: number; // 商品销量
+    marketPrice?: number; // 市场价
+    costPrice?: number; // 成本价
+    stock?: number; // 商品库存
+    createTime?: Date; // 商品创建时间
+    status?: number; // 商品状态
+    browseCount?: number; // 浏览量
  }

  /** 商品状态更新 */
  export interface StatusUpdate {
-    /** 商品编号 */
-    id: number;
-    /** 商品状态 */
-    status: number;
+    id: number; // 商品编号
+    status: number; // 商品状态
  }
 }