Browse Source

部分注释补全

cup 3 years ago
parent
commit
1abff02d0a

+ 6 - 0
mp-admin/src/main/java/com/qs/mp/web/controller/api/user/UserMineController.java

@@ -27,6 +27,9 @@ import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
 import java.util.List;
 import java.util.Map;
+
+import io.swagger.annotations.ApiResponse;
+import io.swagger.annotations.ApiResponses;
 import lombok.AllArgsConstructor;
 import ma.glasnost.orika.MapperFacade;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -66,6 +69,9 @@ public class UserMineController extends BaseApiController {
    */
   @PostMapping("/ticket/list")
   @ApiOperation(value = "我的盲票列表", notes = "获取我的盲票列表")
+  @ApiResponses(
+          @ApiResponse(code = 200, message = "成功", response = TicketListVO.class)
+  )
   public TableDataInfo listTicket(@RequestBody Ticket param) {
     Long userId = SecurityUtils.getLoginUser().getUserId();
     startPage();

+ 17 - 0
mp-service/src/main/java/com/qs/mp/admin/domain/Ticket.java

@@ -10,6 +10,9 @@ import com.baomidou.mybatisplus.annotation.Version;
 import com.qs.mp.common.enums.TicketStatusEnum;
 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_ticket")
 @Data
+@ApiModel(value = "盲票实体类")
 public class Ticket implements Serializable {
 
   private static final long serialVersionUID = 1L;
@@ -27,60 +31,70 @@ public class Ticket implements Serializable {
    * 主键
    */
   @TableId(value = "ticket_id", type = IdType.INPUT)
+  @ApiModelProperty("盲票id")
   private String ticketId;
 
   /**
    * 盲票组ID
    */
   @TableField("box_id")
+  @ApiModelProperty("盲票组ID")
   private String boxId;
 
   /**
    * 盲票包ID
    */
   @TableField("pkg_id")
+  @ApiModelProperty("盲票包ID")
   private String pkgId;
 
   /**
    * 标题
    */
   @TableField("title")
+  @ApiModelProperty("标题")
   private String title;
 
   /**
    * 序列号
    */
   @TableField("serial_no")
+  @ApiModelProperty("序列号")
   private String serialNo;
 
   /**
    * 面值
    */
   @TableField("face_price")
+  @ApiModelProperty("面值")
   private Integer facePrice;
 
   /**
    * 加密幸运数字
    */
   @TableField("cipher_lucky_num")
+  @ApiModelProperty("加密幸运数字")
   private String cipherLuckyNum;
 
   /**
    * 明文幸运数字
    */
   @TableField("plain_lucky_num")
+  @ApiModelProperty("明文幸运数字")
   private Integer plainLuckyNum;
 
   /**
    * 抽奖数字描述(json格式,包含数字、奖项)
    */
   @TableField("draw_num")
+  @ApiModelProperty("抽奖数字描述(json格式,包含数字、奖项)")
   private String drawNum;
 
   /**
    * 是否实体纸质票(0否1是)
    */
   @TableField("is_physical")
+  @ApiModelProperty("是否实体纸质票(0否1是)")
   private Integer isPhysical;
 
   /**
@@ -88,12 +102,14 @@ public class Ticket implements Serializable {
    */
   @TableField("status")
   @JSONField(serialzeFeatures = SerializerFeature.WriteEnumUsingToString)
+  @ApiModelProperty("盲票状态;1未付款、2已激活、3已兑奖、4付款中")
   private TicketStatusEnum status;
 
   /**
    * 创建时间
    */
   @TableField("created_time")
+  @ApiModelProperty("创建时间")
   private Date createdTime;
 
   /**
@@ -101,6 +117,7 @@ public class Ticket implements Serializable {
    */
   @TableField("updated_time")
   @Version
+  @ApiModelProperty("更新时间")
   private Date updatedTime;
 
 

+ 13 - 0
mp-service/src/main/java/com/qs/mp/admin/domain/vo/TicketListVO.java

@@ -1,6 +1,9 @@
 package com.qs.mp.admin.domain.vo;
 
 import java.util.List;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -8,51 +11,61 @@ import lombok.Data;
  * @Date 2022/3/7
  */
 @Data
+@ApiModel("盲票列表VO类")
 public class TicketListVO {
 
   /**
    * 订单明细ID
    */
+  @ApiModelProperty("订单明细id")
   private String itemId;
 
   /**
    * 盲票ID
    */
+  @ApiModelProperty("盲票id")
   private String ticketId;
 
   /**
    * 盲票组ID
    */
+  @ApiModelProperty("盲票组id")
   private String boxId;
 
   /**
    * 标题
    */
+  @ApiModelProperty("标题")
   private String title;
 
   /**
    * 图片
    */
+  @ApiModelProperty("图片")
   private String picUrl;
 
   /**
    * 序列号
    */
+  @ApiModelProperty("序列号")
   private String serialNo;
 
   /**
    * 面值
    */
+  @ApiModelProperty("面值")
   private Integer facePrice;
 
   /**
    * 明文幸运数字
    */
+  @ApiModelProperty("明文幸运数字")
   private Integer plainLuckyNum;
 
   /**
    * 盲票状态(初始、已激活、已兑奖)
    */
+  @ApiModelProperty("盲票状态(初始、已激活、已兑奖)")
   private String status;
 
 }