浏览代码

Swagger注释补齐

cup 3 年之前
父节点
当前提交
f47d3b388b

+ 19 - 0
mp-service/src/main/java/com/qs/mp/admin/domain/vo/TicketBoxListVO.java

@@ -6,6 +6,9 @@ import com.baomidou.mybatisplus.annotation.TableId;
 import com.qs.mp.admin.domain.TicketBox;
 import java.math.BigDecimal;
 import java.util.Date;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -13,79 +16,95 @@ import lombok.Data;
  * @Date 2022/3/3
  */
 @Data
+@ApiModel("盲票组列表出参类")
 public class TicketBoxListVO {
   /**
    * 主键
    */
+  @ApiModelProperty("盲票组id")
   private String boxId;
 
   /**
    * 盲票组标题
    */
+  @ApiModelProperty("盲票组标题")
   private String title;
 
   /**
    * 主图url
    */
+  @ApiModelProperty("主图Url")
   private String picUrl;
 
   /**
    * 盲票张数
    */
+  @ApiModelProperty("盲票张数")
   private Integer quantity;
 
   /**
    * 已售盲票张数
    */
+  @ApiModelProperty("已售盲票张数")
   private Integer saleQty;
 
   /**
    * 盲票包原价
    */
+  @ApiModelProperty("盲票包原价")
   private Integer pkgPrice;
 
   /**
    * 盲票包售价
    */
+  @ApiModelProperty("盲票包售价")
   private Integer pkgSalePrice;
 
   /**
    * 每包盲票张数
    */
+  @ApiModelProperty("每包盲票张数")
   private Integer pkgUnit;
 
   /**
    * 盲票包数
    */
+  @ApiModelProperty("盲票包数")
   private Integer pkgQty;
 
   /**
    * 已销售包数
    */
+  @ApiModelProperty("已销售包数")
   private Integer salePkgQty;
 
   /**
    * 盲票票面价格
    */
+  @ApiModelProperty("盲票票面价格")
   private Integer facePrice;
 
   /**
    * 盲票销售价格
    */
+  @ApiModelProperty("盲票销售价格")
   private Integer salePrice;
 
   /**
    * 分佣的销售额百分比
    */
+  @ApiModelProperty("分佣的销售额百分比")
   private BigDecimal saleCommRate;
 
   /**
    * 规格属性
    */
+  @ApiModelProperty("规格属性")
   private String properties;
 
   /**
    * 上架时间
    */
+  @ApiModelProperty("上架时间")
   private Date onTime;
 }

+ 5 - 0
mp-service/src/main/java/com/qs/mp/channel/domain/vo/ChannelCartVO.java

@@ -1,6 +1,8 @@
 package com.qs.mp.channel.domain.vo;
 
 import com.qs.mp.admin.domain.vo.TicketBoxListVO;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -8,14 +10,17 @@ import lombok.Data;
  * @Date 2022/3/3
  */
 @Data
+@ApiModel("经销商购物车出参类")
 public class ChannelCartVO extends TicketBoxListVO {
 
   /**
    * 购物车清单ID
    */
+  @ApiModelProperty("购物车清单ID")
   private Long cartId;
   /**
    * 订购数量
    */
+  @ApiModelProperty("订购数量")
   private Integer orderNum;
 }

+ 11 - 0
mp-service/src/main/java/com/qs/mp/channel/domain/vo/ChannelOrderSettleVO.java

@@ -3,6 +3,9 @@ package com.qs.mp.channel.domain.vo;
 import com.qs.mp.user.domain.UserAddr;
 import java.util.ArrayList;
 import java.util.List;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -10,37 +13,45 @@ import lombok.Data;
  * @Date 2022/3/3
  */
 @Data
+@ApiModel("经销商订单结算出参类")
 public class ChannelOrderSettleVO {
 
+  @ApiModelProperty("用户地址")
   private UserAddr addr;
 
   /**
    * 订单金额
    */
+  @ApiModelProperty("订单金额")
   private Integer orderAmt = 0;
 
   /**
    * 优惠金额
    */
+  @ApiModelProperty("优惠金额")
   private Integer discountAmt = 0;
 
   /**
    * 运费金额
    */
+  @ApiModelProperty("运费金额")
   private Integer freightAmt = 0;
 
   /**
    * 实付金额
    */
+  @ApiModelProperty("实付金额")
   private Integer payAmt = 0;
 
   /**
    * 订单明细
    */
+  @ApiModelProperty("订单明细")
   private List<ChannelCartVO> items = new ArrayList<>();
 
   /**
    * 盲票包数
    */
+  @ApiModelProperty("盲票包数")
   private Integer pkgNum = 0;
 }