Przeglądaj źródła

swagger注释补齐

cup 2 lat temu
rodzic
commit
e063e47094

+ 1 - 1
mp-service/src/main/java/com/qs/mp/system/domain/vo/WxLoginParams.java

@@ -32,7 +32,7 @@ public class WxLoginParams {
     private int identity;
 
 
-    @ApiModelProperty("小程序,1盲票,2码上兑券")
+    @ApiModelProperty("小程序,1盲票,2码上兑券,3支付宝盲票")
     private Integer appSource;
 
 }

+ 3 - 0
mp-service/src/main/java/com/qs/mp/user/domain/param/TicketOrderParam.java

@@ -23,4 +23,7 @@ public class TicketOrderParam {
 
 	@ApiModelProperty(value = "系统自动选择优惠券,1代表系统自动选择,忽略couponIds,首次请求时传1;0代表以传入的couponIds为准",required=false)
 	private Integer autoCoupon;
+
+	@ApiModelProperty("小程序,1盲票,2码上兑券,3支付宝盲票")
+	private Integer appSource;
 }

+ 60 - 44
mp-service/src/main/java/com/qs/mp/user/domain/vo/TicketOrderSettleVO.java

@@ -1,5 +1,7 @@
 package com.qs.mp.user.domain.vo;
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import java.util.ArrayList;
 import java.util.List;
 import lombok.Data;
@@ -9,51 +11,65 @@ import lombok.Data;
  * @Date 2022/3/3
  */
 @Data
+@ApiModel("盲票订单结算出参类")
 public class TicketOrderSettleVO {
 
-  /**
-   * 订单金额
-   */
-  private Integer orderAmt = 0;
-
-  /**
-   * 优惠金额
-   */
-  private Integer discountAmt = 0;
-
-  /**
-   * 实付金额
-   */
-  private Integer payAmt = 0;
-
-  /**
-   * 票组ID
-   */
-  private String boxId;
-
-  /**
-   * 订购数量
-   */
-  private Integer orderNum;
-
-  /**
-   * 盲票ID
-   */
-  private String ticketId;
-
-  /**
-   * 盲票图片
-   */
-  private String picUrl;
-
-  /**
-   * 盲票标题
-   */
-  private String title;
-
-  /**
-   * 使用优惠券列表
-   */
-  List<UserCoupon4OrderVO> couponList = new ArrayList<>();
+    /**
+     * 订单金额
+     */
+    @ApiModelProperty("订单金额")
+    private Integer orderAmt = 0;
+
+    /**
+     * 优惠金额
+     */
+    @ApiModelProperty("优惠金额")
+    private Integer discountAmt = 0;
+
+    /**
+     * 实付金额
+     */
+    @ApiModelProperty("实付金额")
+    private Integer payAmt = 0;
+
+    /**
+     * 票组ID
+     */
+    @ApiModelProperty("票组id")
+    private String boxId;
+
+    /**
+     * 订购数量
+     */
+    @ApiModelProperty("订购数量")
+    private Integer orderNum;
+
+    /**
+     * 盲票ID
+     */
+    @ApiModelProperty("盲票id")
+    private String ticketId;
+
+    /**
+     * 盲票图片
+     */
+    @ApiModelProperty("盲票图片")
+    private String picUrl;
+
+    /**
+     * 盲票标题
+     */
+    @ApiModelProperty("盲票图片")
+    private String title;
+
+
+    @ApiModelProperty("小程序,1盲票,2码上兑券,3支付宝盲票")
+    private Integer appSource;
+
+    /**
+     * 使用优惠券列表
+     */
+    @ApiModelProperty("使用优惠券列表")
+    List<UserCoupon4OrderVO> couponList = new ArrayList<>();
 
 }

+ 18 - 10
mp-service/src/main/java/com/qs/mp/user/domain/vo/UserCoupon4OrderVO.java

@@ -6,6 +6,8 @@ import com.qs.mp.common.enums.CouponDiscountTypeEnum;
 import com.qs.mp.common.enums.CouponTypeEnum;
 import com.qs.mp.common.enums.CouponUseAreaEnum;
 import com.qs.mp.user.domain.UserCoupon;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -14,20 +16,26 @@ import lombok.Data;
  * @create 2022-03-07 20:45:43
  */
 @Data
+@ApiModel("盲票购买时的优惠券")
 public class UserCoupon4OrderVO {
-  private String id;
 
-  private String title;
+    @ApiModelProperty("id")
+    private String id;
 
-  /**
-   * 图片
-   */
-  private String picUrl;
+    @ApiModelProperty("标题")
+    private String title;
 
-  /**
-   * 优惠金额(比例)
-   */
-  private Integer discount;
+    /**
+     * 图片
+     */
+    @ApiModelProperty("图片")
+    private String picUrl;
+
+    /**
+     * 优惠金额(比例)
+     */
+    @ApiModelProperty("优惠金额(比例)")
+    private Integer discount;
 
 
 }