Swagger注释补齐

mp-admin/src/main/java/com/qs/mp/web/controller/api/admin/ChannelOrderMgrController.java

@@ -89,6 +89,9 @@ public class ChannelOrderMgrController extends BaseApiController {
   @PostMapping("/list")
   @ApiOperation(value = "订单列表" , notes = "获取所有订单信息")
   @PreAuthorize("@ss.hasPermi('order:channel:list')")
+  @ApiResponses(
+		  @ApiResponse(code = 200, message = "success", response = ChannelOrderVO.class)
+  )
   public TableDataInfo list(@RequestBody ChannelOrderQueryParam queryParam) {
     startPage();
     QueryWrapper<ChannelOrder> queryWrapper = new QueryWrapper<ChannelOrder>();

mp-common/src/main/java/com/qs/mp/common/enums/ChannelOrderTypeEnum.java

@@ -13,7 +13,8 @@ import com.qs.mp.common.json.EnumValueDeserializer;
 public enum ChannelOrderTypeEnum implements IEnum<Integer> {
 
     RETAIL(1,"零售票"),
-    PRE(2,"预购票");
+    OFFLINE_PRE(2,"线下预购票"),
+    ONLINE_PRE(3,"线上预购票");
 
     private final int value;
     private final String desc;

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

@@ -30,7 +30,7 @@ public class ChannelOrderQueryParam {
 	@ApiModelProperty(value = "订单状态", required = false)
 	private Integer status;
 
-	@ApiModelProperty("订单类型:1零售票,2预购票")
+	@ApiModelProperty("订单类型1零售票,2线下预购票,3线上预购票")
 	private Integer type;
 	
 	/**

mp-service/src/main/java/com/qs/mp/channel/domain/ChannelOrderDetail.java

@@ -6,6 +6,9 @@ import com.baomidou.mybatisplus.annotation.TableId;
 import com.baomidou.mybatisplus.annotation.TableName;
 import java.io.Serializable;
 import java.util.Date;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -15,6 +18,7 @@ import lombok.Data;
  */
 @TableName("mp_channel_order_detail")
 @Data
+@ApiModel("经销商采购订单盲票包明细实体类")
 public class ChannelOrderDetail implements Serializable {
 
   private static final long serialVersionUID = 1L;
@@ -22,54 +26,63 @@ public class ChannelOrderDetail implements Serializable {
   /**
    * 主键
    */
+  @ApiModelProperty("主键")
   @TableId(value = "id" , type = IdType.AUTO)
   private Long id;
 
   /**
    * 订单ID
    */
+  @ApiModelProperty("订单id")
   @TableField("order_id")
   private String orderId;
 
   /**
    * 渠道ID
    */
+  @ApiModelProperty("渠道id")
   @TableField("channel_id")
   private Long channelId;
 
   /**
    * 盲票组ID
    */
+  @ApiModelProperty("盲票组id")
   @TableField("box_id")
   private String boxId;
 
   /**
    * 盲票包ID
    */
+  @ApiModelProperty("盲票包id")
   @TableField("pkg_id")
   private String pkgId;
 
   /**
    * 起始序号
    */
+  @ApiModelProperty("起始序号")
   @TableField("start_sn")
   private String startSn;
 
   /**
    * 结束序号
    */
+  @ApiModelProperty("结束序号")
   @TableField("end_sn")
   private String endSn;
 
   /**
    * 创建时间
    */
+  @ApiModelProperty("创建时间")
   @TableField("created_time")
   private Date createdTime;
 
   /**
    * 更新时间
    */
+  @ApiModelProperty("更新时间")
   @TableField("updated_time")
   private Date updatedTime;
 

mp-service/src/main/java/com/qs/mp/channel/domain/ChannelOrderItem.java

@@ -6,6 +6,9 @@ import com.baomidou.mybatisplus.annotation.TableId;
 import com.baomidou.mybatisplus.annotation.TableName;
 import java.io.Serializable;
 import java.util.Date;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -15,6 +18,7 @@ import lombok.Data;
  */
 @TableName("mp_channel_order_item")
 @Data
+@ApiModel("经销商订单明细")
 public class ChannelOrderItem implements Serializable {
 
   private static final long serialVersionUID = 1L;
@@ -22,78 +26,91 @@ public class ChannelOrderItem implements Serializable {
   /**
    * 主键
    */
+  @ApiModelProperty("主键")
   @TableId(value = "id" , type = IdType.AUTO)
   private Long id;
 
   /**
    * 订单ID
    */
+  @ApiModelProperty("订单id")
   @TableField("order_id")
   private String orderId;
 
   /**
    * 渠道ID
    */
+  @ApiModelProperty("渠道id")
   @TableField("channel_id")
   private Long channelId;
 
   /**
    * 盲票组标题
    */
+  @ApiModelProperty("盲票组标题")
   @TableField("title")
   private String title;
 
   /**
    * 盲票组主图
    */
+  @ApiModelProperty("盲票组主图")
   @TableField("pic_url")
   private String picUrl;
 
   /**
    * 盲票组ID
    */
+  @ApiModelProperty("盲票组id")
   @TableField("box_id")
   private String boxId;
 
   /**
    * 盲票组属性
    */
+  @ApiModelProperty("盲票组属性")
   @TableField("properties")
   private String properties;
 
   /**
    * 每包盲票张数
    */
+  @ApiModelProperty("每包盲票张数")
   @TableField("pkg_unit")
   private Integer pkgUnit;
 
   /**
    * 盲票面值
    */
+  @ApiModelProperty("盲票面值")
   @TableField("face_price")
   private Integer facePrice;
 
   /**
    * 盲票包数量
    */
+  @ApiModelProperty("盲票包数量")
   @TableField("order_num")
   private Integer orderNum;
 
   /**
    * 盲票包单价
    */
+  @ApiModelProperty("盲票包单价")
   @TableField("pkg_sale_price")
   private Integer pkgSalePrice;
 
   /**
    * 创建时间
    */
+  @ApiModelProperty("创建时间")
   @TableField("created_time")
   private Date createdTime;
 
   /**
    * 更新时间
    */
+  @ApiModelProperty("更新时间")
   @TableField("updated_time")
   private Date updatedTime;
 

mp-service/src/main/java/com/qs/mp/channel/domain/vo/ChannelOrderItemVO.java

@@ -4,6 +4,8 @@ import java.util.List;
 
 import com.qs.mp.channel.domain.ChannelOrderDetail;
 import com.qs.mp.channel.domain.ChannelOrderItem;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -11,11 +13,14 @@ import lombok.Data;
  * @Date 2022/3/3
  */
 @Data
+@ApiModel("经销商订单明细出参类")
 public class ChannelOrderItemVO extends ChannelOrderItem {
 	
 	// 盲票组编号
+	@ApiModelProperty("盲票组编号")
 	private String boxNo;
 	
 	// 发货的票包详情
+	@ApiModelProperty("发货的票包详情")
 	private List<ChannelOrderDetail> detailList;
 }

mp-service/src/main/java/com/qs/mp/channel/domain/vo/ChannelOrderVO.java

@@ -3,6 +3,9 @@ package com.qs.mp.channel.domain.vo;
 import com.qs.mp.channel.domain.ChannelOrder;
 import com.qs.mp.channel.domain.ChannelOrderItem;
 import java.util.List;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -10,13 +13,18 @@ import lombok.Data;
  * @Date 2022/3/3
  */
 @Data
+@ApiModel("经销商订单出参类")
 public class ChannelOrderVO extends ChannelOrder {
 
+  @ApiModelProperty("经销商订单明细出参类")
   private List<ChannelOrderItemVO> items;
 
+  @ApiModelProperty("经销商名称")
   private String channelName;  // 经销商名称
-  
+
+  @ApiModelProperty("上级渠道名称")
   private String parentName;  // 上级渠道名称
 
+  @ApiModelProperty("物流公司名称")
   private String companyName; // 物流公司名称
 }