소스 검색

Swagger注释补齐

cup 3 년 전
부모
커밋
2f411df29b
2개의 변경된 파일29개의 추가작업 그리고 0개의 파일을 삭제
  1. 25 0
      mp-service/src/main/java/com/qs/mp/admin/domain/Goods.java
  2. 4 0
      mp-service/src/main/java/com/qs/mp/admin/domain/TicketBox.java

+ 25 - 0
mp-service/src/main/java/com/qs/mp/admin/domain/Goods.java

@@ -20,6 +20,8 @@ import java.util.Map;
 import java.util.Set;
 import java.util.stream.*;
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -29,6 +31,7 @@ import lombok.Data;
  */
 @TableName("mp_goods")
 @Data
+@ApiModel("商品库实体类")
 public class Goods implements Serializable {
 
   private static final long serialVersionUID = 1L;
@@ -36,84 +39,102 @@ public class Goods implements Serializable {
   /**
    * 主键
    */
+  @ApiModelProperty("商品ID,主键")
   @TableId(value = "goods_id", type = IdType.AUTO)
   private Long goodsId;
 
   /**
    * 商品标题
    */
+  @ApiModelProperty("商品标题")
   @TableField("title")
   private String title;
 
   /**
    * 商品类目ID
    */
+  @ApiModelProperty("商品类目ID")
   @TableField("category_id")
   private Long categoryId;
 
   /**
    * 商品图片
    */
+  @ApiModelProperty("商品图片")
   @TableField("pic_url")
   private String picUrl;
 
   /**
    * 详情
    */
+  @ApiModelProperty("详情")
   @TableField("description")
   private String description;
 
   /**
    * 原兑换价格
    */
+  @ApiModelProperty("原兑换价格")
   @TableField("origin_price")
   private Integer originPrice;
 
   /**
    * 现兑换价格
    */
+  @ApiModelProperty("现兑换价格")
   @TableField("exchange_price")
   private Integer exchangePrice;
 
   /**
    * 商品价值
    */
+  @ApiModelProperty("商品价值")
   @TableField("value")
   private Integer value;
 
   /**
    * 商品成本
    */
+  @ApiModelProperty("商品成本")
   @TableField("cost")
   private Integer cost;
 
   /**
    * 库存数量
    */
+  @ApiModelProperty("库存数量")
   @TableField("quantity")
   private Integer quantity;
 
   /**
    * 已兑换量
    */
+  @ApiModelProperty("已兑换量")
   @TableField("exchanged_qty")
   private Integer exchangedQty;
 
   /**
    * 兑换大厅是否展示,0不展示,1展示
    */
+  @ApiModelProperty("兑换大厅是否展示,0不展示,1展示")
   @TableField("exchange_show")
   private Integer exchangeShow;
 
+  @ApiModelProperty("排序权重,越大越靠前")
+  @TableField("sort_weight")
+  private Integer sortWeight;
+
   /**
    * 是否多sku,0否,1是
    */
+  @ApiModelProperty("是否多sku,0否,1是")
   @TableField("multi_sku")
   private Integer multiSku;
 
   /**
    * 规格描述
    */
+  @ApiModelProperty("规格描述")
   @TableField("sku_prop")
   private String skuProp;
 
@@ -121,6 +142,7 @@ public class Goods implements Serializable {
   /**
    * 上架状态;上架/下架
    */
+  @ApiModelProperty("上架状态;上架/下架")
   @TableField("status")
   @JSONField(serialzeFeatures = SerializerFeature.WriteEnumUsingToString)
   private GoodsStatusEnum status;
@@ -128,6 +150,7 @@ public class Goods implements Serializable {
   /**
    * 逻辑删除标识
    */
+  @ApiModelProperty("逻辑删除标识")
   @TableField("is_deleted")
   @TableLogic
   private Integer isDeleted;
@@ -135,12 +158,14 @@ public class Goods implements Serializable {
   /**
    * 创建时间
    */
+  @ApiModelProperty("创建时间")
   @TableField("created_time")
   private Date createdTime;
 
   /**
    * 更新时间
    */
+  @ApiModelProperty("更新时间")
   @TableField("updated_time")
   private Date updatedTime;
 }

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

@@ -156,6 +156,10 @@ public class TicketBox implements Serializable {
   @TableField("properties")
   private String properties;
 
+  @ApiModelProperty("排序权重,越大越靠前")
+  @TableField("sort_weight")
+  private Integer sortWeight;
+
   /**
    * 上架时间
    */