注释补全

mp-service/src/main/java/com/qs/mp/admin/domain/TicketAwards.java

@@ -7,6 +7,9 @@ import com.baomidou.mybatisplus.annotation.TableName;
 import java.io.Serializable;
 import java.math.BigDecimal;
 import java.util.Date;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -16,6 +19,7 @@ import lombok.Data;
  */
 @TableName("mp_ticket_awards")
 @Data
+@ApiModel("盲票盒奖项设置实体类")
 public class TicketAwards implements Serializable {
 
   private static final long serialVersionUID = 1L;
@@ -23,60 +27,70 @@ public class TicketAwards implements Serializable {
   /**
    * 主键
    */
+  @ApiModelProperty("奖项ID,主键")
   @TableId(value = "awards_id" , type = IdType.INPUT)
   private String awardsId;
 
   /**
    * 盲票组ID
    */
+  @ApiModelProperty("盲票组ID")
   @TableField("box_id")
   private String boxId;
 
   /**
    * 奖项名
    */
+  @ApiModelProperty("奖项名")
   @TableField("name")
   private String name;
 
   /**
    * 奖项顺序
    */
+  @ApiModelProperty("奖项顺序")
   @TableField("sort")
   private Integer sort;
 
   /**
    * 奖项数量
    */
+  @ApiModelProperty("奖项数量")
   @TableField("quantity")
   private Integer quantity;
 
   /**
    * 奖项描述
    */
+  @ApiModelProperty("奖项描述")
   @TableField("memo")
   private String memo;
 
   /**
    * 中奖率
    */
+  @ApiModelProperty("中奖率")
   @TableField("hit_rate")
   private BigDecimal hitRate;
 
   /**
    * 已兑奖数量
    */
+  @ApiModelProperty("已兑奖数量")
   @TableField("cashed_qty")
   private Integer cashedQty;
 
   /**
    * 创建时间
    */
+  @ApiModelProperty("创建时间")
   @TableField("created_time")
   private Date createdTime;
 
   /**
    * 更新时间
    */
+  @ApiModelProperty("更新时间")
   @TableField("updated_time")
   private Date updatedTime;
 

mp-service/src/main/java/com/qs/mp/admin/domain/TicketAwardsPrize.java

@@ -9,6 +9,9 @@ import com.baomidou.mybatisplus.annotation.TableName;
 import com.qs.mp.common.enums.TicketPrizeTypeEnum;
 import java.io.Serializable;
 import java.util.Date;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -18,6 +21,7 @@ import lombok.Data;
  */
 @TableName("mp_ticket_awards_prize")
 @Data
+@ApiModel("盲票盒奖项对应的奖品设置实体类")
 public class TicketAwardsPrize implements Serializable {
 
   private static final long serialVersionUID = 1L;
@@ -25,42 +29,49 @@ public class TicketAwardsPrize implements Serializable {
   /**
    * 主键
    */
+  @ApiModelProperty("奖品id,主键")
   @TableId(value = "prize_id" , type = IdType.INPUT)
   private String prizeId;
 
   /**
    * 盲票组ID
    */
+  @ApiModelProperty("盲票组ID")
   @TableField("box_id")
   private String boxId;
 
   /**
    * 奖项ID
    */
+  @ApiModelProperty("奖项ID")
   @TableField("awards_id")
   private String awardsId;
 
   /**
    * 奖品ID（GOODS_ID或COUPON_ID)
    */
+  @ApiModelProperty("奖品ID（GOODS_ID或COUPON_ID)")
   @TableField("ref_id")
   private String refId;
 
   /**
    * 奖品名称
    */
+  @ApiModelProperty("奖品名称")
   @TableField("title")
   private String title;
 
   /**
    * 奖品图片url
    */
+  @ApiModelProperty("奖品图片url")
   @TableField("pic_url")
   private String picUrl;
 
   /**
    * 奖品类型 1 实物商品 2优惠券 3平台代币
    */
+  @ApiModelProperty("奖品类型 1 实物商品 2优惠券 3平台代币")
   @TableField("prize_type")
   @JSONField(serialzeFeatures = SerializerFeature.WriteEnumUsingToString)
   private TicketPrizeTypeEnum prizeType;
@@ -68,36 +79,42 @@ public class TicketAwardsPrize implements Serializable {
   /**
    * 奖品数
    */
+  @ApiModelProperty("奖品数")
   @TableField("quantity")
   private Integer quantity;
 
   /**
    * 已兑奖品数
    */
+  @ApiModelProperty("已兑奖品数")
   @TableField("cashed_qty")
   private Integer cashedQty;
 
   /**
    * 剩余奖品数
    */
+  @ApiModelProperty("剩余奖品数")
   @TableField("remain_qty")
   private Integer remainQty;
 
   /**
    * 奖品价值
    */
+  @ApiModelProperty("奖品价值")
   @TableField("value")
   private Integer value;
 
   /**
    * 创建时间
    */
+  @ApiModelProperty("创建时间")
   @TableField("created_time")
   private Date createdTime;
 
   /**
    * 更新时间
    */
+  @ApiModelProperty("更新时间")
   @TableField("updated_time")
   private Date updatedTime;
 

mp-service/src/main/java/com/qs/mp/admin/domain/TicketBox.java

@@ -13,6 +13,9 @@ import com.qs.mp.common.enums.TicketTypeEnum;
 import java.io.Serializable;
 import java.math.BigDecimal;
 import java.util.Date;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -20,6 +23,7 @@ import lombok.Data;
  * @auther quanshu
  * @create 2022-03-02 12:25:55
  */
+@ApiModel("盲票组实体类")
 @TableName("mp_ticket_box")
 @Data
 public class TicketBox implements Serializable {
@@ -29,48 +33,56 @@ public class TicketBox implements Serializable {
   /**
    * 主键
    */
+  @ApiModelProperty("盲票组id")
   @TableId(value = "box_id" , type = IdType.INPUT)
   private String boxId;
 
   /**
    * 盲票组编号
    */
+  @ApiModelProperty("盲票组编号")
   @TableField("box_no")
   private String boxNo;
 
   /**
    * 盲票组标题
    */
+  @ApiModelProperty("盲票组标题")
   @TableField("title")
   private String title;
 
   /**
    * 主图url
    */
+  @ApiModelProperty("主图url")
   @TableField("pic_url")
   private String picUrl;
 
   /**
    * 盲票类别
    */
+  @ApiModelProperty("盲票类别")
   @TableField("category_id")
   private Long categoryId;
 
   /**
    * 详细描述
    */
+  @ApiModelProperty("详细描述")
   @TableField("description")
   private String description;
 
   /**
    * 卖点
    */
+  @ApiModelProperty("卖点")
   @TableField("sale_point")
   private String salePoint;
 
   /**
    * 盲票形式（线上或线下）
    */
+  @ApiModelProperty("盲票形式（线上或线下）")
   @TableField("type")
   @JSONField(serialzeFeatures = SerializerFeature.WriteEnumUsingToString)
   private TicketTypeEnum type;
@@ -78,6 +90,7 @@ public class TicketBox implements Serializable {
   /**
    * 盲票张数
    */
+  @ApiModelProperty("盲票张数")
   @TableField("quantity")
   private Integer quantity;
 
@@ -90,72 +103,84 @@ public class TicketBox implements Serializable {
   /**
    * 盲票包售价
    */
+  @ApiModelProperty("盲票包售价")
   @TableField("pkg_sale_price")
   private Integer pkgSalePrice;
 
   /**
    * 每包盲票张数
    */
+  @ApiModelProperty("每包盲票张数")
   @TableField("pkg_unit")
   private Integer pkgUnit;
 
   /**
    * 盲票包数
    */
+  @ApiModelProperty("盲票包数")
   @TableField("pkg_qty")
   private Integer pkgQty;
 
   /**
    * 已销售包数
    */
+  @ApiModelProperty("已销售包数")
   @TableField("sale_pkg_qty")
   private Integer salePkgQty;
 
   /**
    * 盲票票面价格
    */
+  @ApiModelProperty("盲票票面价格")
   @TableField("face_price")
   private Integer facePrice;
 
   /**
    * 盲票销售价格
    */
+  @ApiModelProperty("盲票销售价格")
   @TableField("sale_price")
   private Integer salePrice;
 
   /**
    * 分佣的销售额百分比
    */
+  @ApiModelProperty("分佣的销售额百分比")
   @TableField("sale_comm_rate")
   private BigDecimal saleCommRate;
 
   /**
    * 规格属性
    */
+  @ApiModelProperty("规格属性")
   @TableField("properties")
   private String properties;
 
   /**
    * 上架时间
    */
+  @ApiModelProperty("上架时间")
   @TableField("on_time")
   private Date onTime;
 
   /**
    * 下架时间
    */
+  @ApiModelProperty("下架时间")
   @TableField("off_time")
   private Date offTime;
 
   /**
    * 人工下架标识，1为人工下架
    */
+  @ApiModelProperty("人工下架标识，1为人工下架")
   @TableField("manual_off")
   private Integer manualOff;
 
   /**
    * 状态，上架/下架
    */
+  @ApiModelProperty("状态,上架/下架")
   @TableField("status")
   @JSONField(serialzeFeatures = SerializerFeature.WriteEnumUsingToString)
   private TicketBoxStatusEnum status;
@@ -163,6 +188,7 @@ public class TicketBox implements Serializable {
   /**
    * 逻辑删除标识
    */
+  @ApiModelProperty("逻辑删除标识")
   @TableField("is_deleted")
   @TableLogic
   private Integer isDeleted;
@@ -170,12 +196,14 @@ public class TicketBox implements Serializable {
   /**
    * 创建时间
    */
+  @ApiModelProperty("创建时间")
   @TableField("created_time")
   private Date createdTime;
 
   /**
    * 更新时间
    */
+  @ApiModelProperty("更新时间")
   @TableField("updated_time")
   @Version
   private Date updatedTime;

mp-service/src/main/java/com/qs/mp/admin/domain/vo/TicketAwardsPrizeVO.java

@@ -7,6 +7,9 @@ import com.baomidou.mybatisplus.annotation.TableName;
 import java.io.Serializable;
 import java.math.BigDecimal;
 import java.util.Date;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -14,73 +17,93 @@ import lombok.Data;
  * @auther quanshu
  * @create 2022-03-02 12:25:55
  */
+@ApiModel("盲票盒奖项对应的奖品VO")
 @Data
 public class TicketAwardsPrizeVO {
 
   /**
    * 奖项ID
    */
+  @ApiModelProperty("奖项ID")
   private String awardsId;
 
   /**
    * 盲票组ID
    */
+  @ApiModelProperty("盲票组ID")
   private String boxId;
 
   /**
    * 奖项名
    */
+  @ApiModelProperty("奖项名")
   private String name;
 
   /**
    * 奖项顺序
    */
+  @ApiModelProperty("奖项顺序")
   private String sort;
 
   /**
    * 奖项数量
    */
+  @ApiModelProperty("奖项数量")
   private Integer quantity;
 
   /**
    * 奖项描述
    */
+  @ApiModelProperty("奖项描述")
   private String memo;
 
   /**
    * 中奖率
    */
+  @ApiModelProperty("中奖率")
   private BigDecimal hitRate;
 
   /******** 奖品 ********/
   /**
    * 奖品ID
    */
+  @ApiModelProperty("奖品id")
   private String prizeId;
 
   /**
    * 奖品ID（GOODS_ID或COUPON_ID)
    */
+  @ApiModelProperty("奖品ID（GOODS_ID或COUPON_ID)")
   private String refId;
 
   /**
    * 奖品图片
    */
+  @ApiModelProperty("奖品图片")
   private String picUrl;
 
   /**
    * 奖品名称
    */
+  @ApiModelProperty("奖品名称")
   private String title;
 
   /**
    * 奖品类型 1 实物商品 2优惠券 3平台代币
    */
+  @ApiModelProperty("奖品类型 1 实物商品 2优惠券 3平台代币")
   private String prizeType;
 
+  /**
+   * 优惠券类型: 1代金券、2折扣券、3兑换券
+   */
+  @ApiModelProperty("优惠券类型: 1代金券、2折扣券、3兑换券")
+  private String discountType;
+
   /**
    * 奖品价值
    */
+  @ApiModelProperty("奖品价值")
   private Integer value;
 
 

mp-service/src/main/java/com/qs/mp/admin/domain/vo/TicketAwardsVO.java

@@ -4,6 +4,9 @@ import com.qs.mp.admin.domain.TicketAwards;
 import com.qs.mp.admin.domain.TicketAwardsPrize;
 import java.math.BigDecimal;
 import java.util.List;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -12,6 +15,9 @@ import lombok.Data;
  * @create 2022-03-02 12:25:55
  */
 @Data
+@ApiModel("盲票盒奖项对应的奖品VO")
 public class TicketAwardsVO extends TicketAwards {
+
+  @ApiModelProperty("奖品列表")
   List<TicketAwardsPrize> prizeList;
 }

mp-service/src/main/java/com/qs/mp/admin/domain/vo/TicketBoxVO.java

@@ -2,17 +2,24 @@ package com.qs.mp.admin.domain.vo;
 
 import com.qs.mp.admin.domain.TicketBox;
 import java.util.List;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
+ * 票组出参类
  * @author zhongcp
  * @Date 2022/3/5
  */
 @Data
+@ApiModel(value = "票组出参类")
 public class TicketBoxVO extends TicketBox {
   // 奖品列表（小程序端显示）
+  @ApiModelProperty("奖品列表（小程序端显示）")
   List<TicketAwardsPrizeVO> prizeList;
 
   // 奖级列表（后台显示）
+  @ApiModelProperty("奖级列表（后台显示）")
   List<TicketAwardsVO> awardsList;
 }