فهرست منبع

Swagger注释补齐

cup 3 سال پیش
والد
کامیت
f8f04ddd07

+ 17 - 0
mp-service/src/main/java/com/qs/mp/user/domain/UserPrizeStorage.java

@@ -10,6 +10,9 @@ import com.qs.mp.common.enums.PrizeStorageInTypeEnum;
 import com.qs.mp.common.enums.PrizeStorageStatusEnum;
 import java.io.Serializable;
 import java.util.Date;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -19,6 +22,7 @@ import lombok.Data;
  */
 @TableName("mp_user_prize_storage")
 @Data
+@ApiModel(value = "用户实物奖品仓库实体类")
 public class UserPrizeStorage implements Serializable {
 
   private static final long serialVersionUID = 1L;
@@ -27,48 +31,56 @@ public class UserPrizeStorage implements Serializable {
    * 主键
    */
   @TableId(value = "storage_id", type = IdType.INPUT)
+  @ApiModelProperty("主键")
   private String storageId;
 
   /**
    * 用户ID
    */
   @TableField("user_id")
+  @ApiModelProperty("用户ID")
   private Long userId;
 
   /**
    * 商品ID
    */
   @TableField("goods_id")
+  @ApiModelProperty("商品ID")
   private Long goodsId;
 
   /**
    * sku ID
    */
   @TableField("sku_id")
+  @ApiModelProperty("sku ID")
   private Long skuId;
 
   /**
    * sku 属性
    */
   @TableField("properties")
+  @ApiModelProperty("sku 属性")
   private String properties;
 
   /**
    * 商品标题
    */
   @TableField("title")
+  @ApiModelProperty("商品标题")
   private String title;
 
   /**
    * 商品图片
    */
   @TableField("pic_url")
+  @ApiModelProperty("商品图片")
   private String picUrl;
 
   /**
    * 商品数
    */
   @TableField("goods_num")
+  @ApiModelProperty("商品数")
   private Integer goodsNum;
 
   /**
@@ -76,12 +88,14 @@ public class UserPrizeStorage implements Serializable {
    */
   @TableField("in_type")
   @JSONField(serialzeFeatures = SerializerFeature.WriteEnumUsingToString)
+  @ApiModelProperty("入库类型;1盲票兑奖、2盲豆兑换")
   private PrizeStorageInTypeEnum inType;
 
   /**
    * 关联业务ID
    */
   @TableField("ref_id")
+  @ApiModelProperty("关联业务ID")
   private String refId;
 
   /**
@@ -89,17 +103,20 @@ public class UserPrizeStorage implements Serializable {
    */
   @TableField("status")
   @JSONField(serialzeFeatures = SerializerFeature.WriteEnumUsingToString)
+  @ApiModelProperty("状态;1待提货、2已提货")
   private PrizeStorageStatusEnum status;
 
   /**
    * 创建时间
    */
+  @ApiModelProperty("创建时间")
   @TableField("created_time")
   private Date createdTime;
 
   /**
    * 更新时间
    */
+  @ApiModelProperty("更新时间")
   @TableField("updated_time")
   private Date updatedTime;
 

+ 9 - 0
mp-service/src/main/java/com/qs/mp/user/domain/vo/DeliverOrderSettleVO.java

@@ -4,6 +4,9 @@ import com.qs.mp.user.domain.UserAddr;
 import com.qs.mp.user.domain.UserPrizeStorage;
 import java.util.ArrayList;
 import java.util.List;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -11,28 +14,34 @@ import lombok.Data;
  * @Date 2022/3/3
  */
 @Data
+@ApiModel("用户提货订单结算出参类")
 public class DeliverOrderSettleVO {
 
+  @ApiModelProperty("用户配送地址")
   private UserAddr addr;
 
   /**
    * 订单金额
    */
+  @ApiModelProperty("订单金额")
   private Integer orderAmt = 0;
 
   /**
    * 运费
    */
+  @ApiModelProperty("运费")
   private Integer freightAmt = 0;
 
   /**
    * 实付金额
    */
+  @ApiModelProperty("实付金额")
   private Integer payAmt = 0;
 
   /**
    * 奖品库列表
    */
+  @ApiModelProperty("奖品库列表")
   List<UserPrizeStorage> prizeList = new ArrayList<>();
 
 }