From 42a06b543d7a5a4eed75a168926b7f5156659740 Mon Sep 17 00:00:00 2001 From: taochengbo <552920369@qq.com> Date: Sun, 23 Aug 2020 00:44:02 +0800 Subject: [PATCH] =?UTF-8?q?task--=E5=AE=8C=E5=96=84swagger=E6=96=87?= =?UTF-8?q?=E6=A1=A3=E6=B3=A8=E9=87=8A?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../co/yixiang/common/web/param/IdParam.java | 4 +- .../activity/param/BargainShareParam.java | 4 ++ .../activity/param/PinkCancelParam.java | 5 +++ .../activity/param/PinkShareParam.java | 2 + .../YxStoreBargainUserHelpQueryParam.java | 4 ++ .../param/YxStoreBargainUserQueryParam.java | 3 ++ .../activity/rest/StoreBargainController.java | 10 +++++ .../rest/StoreCombinationController.java | 6 +++ .../modules/auth/param/HLoginParam.java | 5 +++ .../modules/auth/param/LoginParam.java | 6 +++ .../yixiang/modules/auth/param/RegParam.java | 7 ++++ .../modules/auth/param/VerityParam.java | 4 ++ .../modules/auth/rest/AuthController.java | 6 +++ .../modules/cart/param/CartIdsParm.java | 3 ++ .../modules/cart/param/CartNumParam.java | 5 +++ .../yixiang/modules/cart/param/CartParam.java | 14 +++++++ .../coupon/param/YxStoreCouponQueryParam.java | 2 + .../modules/coupon/rest/CouponController.java | 11 +++++ .../modules/manage/param/OrderPriceParam.java | 5 +++ .../manage/param/OrderRemarkParam.java | 5 +++ .../manage/param/ShoperQueryParam.java | 3 ++ .../modules/manage/rest/ShoperController.java | 6 +++ .../modules/order/dto/OrderExtendDto.java | 7 ++++ .../order/param/ComputeOrderParam.java | 16 ++++++++ .../order/param/ConfirmOrderParam.java | 3 ++ .../modules/order/param/DoOrderParam.java | 2 + .../modules/order/param/ExpressParam.java | 8 +++- .../modules/order/param/HandleOrderParam.java | 3 ++ .../order/param/OrderDeliveryParam.java | 9 ++++ .../modules/order/param/OrderRefundParam.java | 7 ++++ .../modules/order/param/OrderVerifyParam.java | 4 ++ .../yixiang/modules/order/param/PayParam.java | 7 ++++ .../order/param/ProductOrderParam.java | 3 ++ .../order/param/ProductReplyParam.java | 11 +++++ .../modules/order/param/RefundParam.java | 13 +++++- .../order/rest/StoreOrderController.java | 14 +++++++ .../YxStoreProductRelationQueryParam.java | 5 +++ .../product/rest/StoreProductController.java | 23 +++++++++++ .../shop/param/YxSystemStoreQueryParam.java | 3 ++ .../yixiang/modules/user/param/PromParam.java | 11 +++++ .../modules/user/param/RechargeParam.java | 6 +++ .../modules/user/param/UserEditParam.java | 4 ++ .../modules/user/rest/UserBillController.java | 14 +++++++ .../modules/user/rest/UserController.java | 14 +++++++ .../wechat/rest/param/BindPhoneParam.java | 4 ++ .../wechat/rest/param/WxPhoneParam.java | 5 +++ .../main/java/co/yixiang/api/ApiResult.java | 8 +++- .../modules/activity/param/UserExtParam.java | 9 ++-- .../activity/service/dto/SeckillTimeDto.java | 6 +++ .../modules/activity/vo/SeckillConfigVo.java | 4 +- .../activity/vo/StoreCouponUserVo.java | 12 +++++- .../modules/activity/vo/StoreSeckillVo.java | 5 +++ .../activity/vo/YxStoreBargainQueryVo.java | 5 ++- .../vo/YxStoreCouponIssueQueryVo.java | 7 +++- .../activity/vo/YxStoreCouponUserQueryVo.java | 5 ++- .../activity/vo/YxStorePinkQueryVo.java | 6 ++- .../activity/vo/YxStoreSeckillQueryVo.java | 3 +- .../modules/cart/vo/YxStoreCartQueryVo.java | 10 ++++- .../modules/order/param/ExpressParam.java | 8 +++- .../modules/order/param/OrderParam.java | 30 ++++++++++++++ .../order/service/dto/ProductAttrDto.java | 9 ++++ .../modules/order/service/dto/ProductDto.java | 9 ++++ .../modules/order/vo/OrderCartInfoVo.java | 16 ++++---- .../modules/order/vo/UserOrderCountVo.java | 38 +++++++++++++---- .../modules/order/vo/YxStoreOrderQueryVo.java | 5 ++- .../product/domain/YxStoreProduct.java | 41 +++++++++++++++++-- .../domain/YxStoreProductAttrValue.java | 20 +++++++++ .../param/YxStoreProductQueryParam.java | 12 ++++++ .../yixiang/modules/product/vo/ProductVo.java | 11 ++++- .../modules/product/vo/ReplyCountVo.java | 13 ++++++ .../product/vo/YxStoreProductQueryVo.java | 11 ++++- .../vo/YxStoreProductRelationQueryVo.java | 9 +++- .../vo/YxStoreProductReplyQueryVo.java | 9 ++-- .../product/vo/YxSystemStoreQueryVo.java | 3 +- .../user/param/AddressDetailParam.java | 9 ++++ .../modules/user/param/AddressParam.java | 15 +++++++ .../modules/user/vo/YxUserQueryVo.java | 11 +++++ .../modules/wechat/vo/YxArticleQueryVo.java | 3 +- .../tools/express/dao/ExpressInfo.java | 19 +++++++++ .../co/yixiang/tools/express/dao/Traces.java | 4 ++ 80 files changed, 652 insertions(+), 49 deletions(-) diff --git a/yshop-app/src/main/java/co/yixiang/common/web/param/IdParam.java b/yshop-app/src/main/java/co/yixiang/common/web/param/IdParam.java index ebdc9318..7b57a6af 100644 --- a/yshop-app/src/main/java/co/yixiang/common/web/param/IdParam.java +++ b/yshop-app/src/main/java/co/yixiang/common/web/param/IdParam.java @@ -1,6 +1,7 @@ package co.yixiang.common.web.param; import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import javax.validation.constraints.NotBlank; @@ -11,7 +12,8 @@ import java.io.Serializable; @ApiModel("ID参数") public class IdParam implements Serializable { private static final long serialVersionUID = -5353973980674510450L; - + @NotBlank(message="ID不能为空") + @ApiModelProperty(value = "地址ID") private String id; } diff --git a/yshop-app/src/main/java/co/yixiang/modules/activity/param/BargainShareParam.java b/yshop-app/src/main/java/co/yixiang/modules/activity/param/BargainShareParam.java index 0504f64c..3b2336a9 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/activity/param/BargainShareParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/activity/param/BargainShareParam.java @@ -1,5 +1,6 @@ package co.yixiang.modules.activity.param; +import io.swagger.annotations.ApiModelProperty; import lombok.Getter; import lombok.Setter; @@ -13,8 +14,11 @@ import javax.validation.constraints.NotBlank; @Getter @Setter public class BargainShareParam { + @NotBlank(message = "参数有误") + @ApiModelProperty(value = "砍价产品ID") private String bargainId; + @ApiModelProperty(value = "来源") private String from; } diff --git a/yshop-app/src/main/java/co/yixiang/modules/activity/param/PinkCancelParam.java b/yshop-app/src/main/java/co/yixiang/modules/activity/param/PinkCancelParam.java index 5a82c07b..ed6df019 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/activity/param/PinkCancelParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/activity/param/PinkCancelParam.java @@ -1,5 +1,6 @@ package co.yixiang.modules.activity.param; +import io.swagger.annotations.ApiModelProperty; import lombok.Getter; import lombok.Setter; @@ -13,8 +14,12 @@ import javax.validation.constraints.NotBlank; @Getter @Setter public class PinkCancelParam { + @NotBlank(message = "参数错误") + @ApiModelProperty(value = "拼团产品ID") private String id; + @NotBlank(message = "参数错误") + @ApiModelProperty(value = "团购产品id") private String cid; } diff --git a/yshop-app/src/main/java/co/yixiang/modules/activity/param/PinkShareParam.java b/yshop-app/src/main/java/co/yixiang/modules/activity/param/PinkShareParam.java index 10793403..5e580ff7 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/activity/param/PinkShareParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/activity/param/PinkShareParam.java @@ -1,5 +1,6 @@ package co.yixiang.modules.activity.param; +import io.swagger.annotations.ApiModelProperty; import lombok.Getter; import lombok.Setter; @@ -16,5 +17,6 @@ public class PinkShareParam { @NotBlank(message = "参数有误") private String id; + @ApiModelProperty(value = "来源") private String from; } diff --git a/yshop-app/src/main/java/co/yixiang/modules/activity/param/YxStoreBargainUserHelpQueryParam.java b/yshop-app/src/main/java/co/yixiang/modules/activity/param/YxStoreBargainUserHelpQueryParam.java index 898f6d6c..d397bd2b 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/activity/param/YxStoreBargainUserHelpQueryParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/activity/param/YxStoreBargainUserHelpQueryParam.java @@ -2,6 +2,7 @@ package co.yixiang.modules.activity.param; import co.yixiang.common.web.param.QueryParam; import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import lombok.EqualsAndHashCode; @@ -22,7 +23,10 @@ public class YxStoreBargainUserHelpQueryParam extends QueryParam { private static final long serialVersionUID = 1L; @NotBlank(message = "参数有误") + @ApiModelProperty(value = "砍价产品ID") private String bargainId; + @NotBlank(message = "参数有误") + @ApiModelProperty(value = "砍价用户id") private String bargainUserUid; } diff --git a/yshop-app/src/main/java/co/yixiang/modules/activity/param/YxStoreBargainUserQueryParam.java b/yshop-app/src/main/java/co/yixiang/modules/activity/param/YxStoreBargainUserQueryParam.java index bc13f3ed..2cc513d5 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/activity/param/YxStoreBargainUserQueryParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/activity/param/YxStoreBargainUserQueryParam.java @@ -2,6 +2,7 @@ package co.yixiang.modules.activity.param; import co.yixiang.common.web.param.QueryParam; import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import lombok.EqualsAndHashCode; @@ -22,8 +23,10 @@ public class YxStoreBargainUserQueryParam extends QueryParam { private static final long serialVersionUID = 1L; @NotBlank(message = "参数错误") + @ApiModelProperty(value = "砍价用户ID") private String bargainUserUid; + @ApiModelProperty(value = "砍价产品ID") private String bargainId; } diff --git a/yshop-app/src/main/java/co/yixiang/modules/activity/rest/StoreBargainController.java b/yshop-app/src/main/java/co/yixiang/modules/activity/rest/StoreBargainController.java index 0bbcb7d7..0aea5733 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/activity/rest/StoreBargainController.java +++ b/yshop-app/src/main/java/co/yixiang/modules/activity/rest/StoreBargainController.java @@ -38,6 +38,8 @@ import co.yixiang.modules.user.service.YxUserService; import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper; import com.google.common.collect.Maps; import io.swagger.annotations.Api; +import io.swagger.annotations.ApiImplicitParam; +import io.swagger.annotations.ApiImplicitParams; import io.swagger.annotations.ApiOperation; import lombok.RequiredArgsConstructor; import org.springframework.beans.factory.annotation.Autowired; @@ -87,6 +89,10 @@ public class StoreBargainController { * 砍价产品列表 */ @GetMapping("/bargain/list") + @ApiImplicitParams({ + @ApiImplicitParam(name = "page", value = "页码,默认为1", paramType = "query", dataType = "int"), + @ApiImplicitParam(name = "limit", value = "页大小,默认为10", paramType = "query", dataType = "int") + }) @ApiOperation(value = "砍价产品列表",notes = "砍价产品列表") public ApiResult getYxStoreBargainPageList(@RequestParam(value = "page",defaultValue = "1") int page, @RequestParam(value = "limit",defaultValue = "10") int limit){ @@ -253,6 +259,10 @@ public class StoreBargainController { */ @AuthCheck @GetMapping("/bargain/user/list") + @ApiImplicitParams({ + @ApiImplicitParam(name = "page", value = "页码,默认为1", paramType = "query", dataType = "int"), + @ApiImplicitParam(name = "limit", value = "页大小,默认为10", paramType = "query", dataType = "int") + }) @ApiOperation(value = "砍价列表(已参与)",notes = "砍价列表(已参与)") public ApiResult> bargainUserList( @RequestParam(value = "page",defaultValue = "1") int page, diff --git a/yshop-app/src/main/java/co/yixiang/modules/activity/rest/StoreCombinationController.java b/yshop-app/src/main/java/co/yixiang/modules/activity/rest/StoreCombinationController.java index 725937f5..e8745625 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/activity/rest/StoreCombinationController.java +++ b/yshop-app/src/main/java/co/yixiang/modules/activity/rest/StoreCombinationController.java @@ -28,6 +28,8 @@ import co.yixiang.modules.shop.service.YxSystemConfigService; import co.yixiang.modules.user.domain.YxUser; import com.google.common.collect.Maps; import io.swagger.annotations.Api; +import io.swagger.annotations.ApiImplicitParam; +import io.swagger.annotations.ApiImplicitParams; import io.swagger.annotations.ApiOperation; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; @@ -72,6 +74,10 @@ public class StoreCombinationController { * 拼团产品列表 */ @GetMapping("/combination/list") + @ApiImplicitParams({ + @ApiImplicitParam(name = "page", value = "页码,默认为1", paramType = "query", dataType = "int"), + @ApiImplicitParam(name = "limit", value = "页大小,默认为10", paramType = "query", dataType = "int") + }) @ApiOperation(value = "拼团产品列表",notes = "拼团产品列表") public ApiResult> getList(@RequestParam(value = "page",defaultValue = "1") int page, @RequestParam(value = "limit",defaultValue = "10") int limit){ diff --git a/yshop-app/src/main/java/co/yixiang/modules/auth/param/HLoginParam.java b/yshop-app/src/main/java/co/yixiang/modules/auth/param/HLoginParam.java index 98d55c9b..5558a68c 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/auth/param/HLoginParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/auth/param/HLoginParam.java @@ -1,6 +1,7 @@ package co.yixiang.modules.auth.param; +import io.swagger.annotations.ApiModelProperty; import lombok.Getter; import lombok.Setter; @@ -14,12 +15,16 @@ import javax.validation.constraints.NotBlank; @Getter @Setter public class HLoginParam { + @NotBlank(message = "用户名必填") + @ApiModelProperty(value = "用户名") private String username; @NotBlank(message = "密码必填") + @ApiModelProperty(value = "密码") private String password; + @ApiModelProperty(value = "分销绑定关系的ID") private String spread; diff --git a/yshop-app/src/main/java/co/yixiang/modules/auth/param/LoginParam.java b/yshop-app/src/main/java/co/yixiang/modules/auth/param/LoginParam.java index 1f968289..c9e36305 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/auth/param/LoginParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/auth/param/LoginParam.java @@ -1,5 +1,6 @@ package co.yixiang.modules.auth.param; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import javax.validation.constraints.NotBlank; @@ -11,12 +12,17 @@ import javax.validation.constraints.NotBlank; **/ @Data public class LoginParam { + @NotBlank(message = "code参数缺失") + @ApiModelProperty(value = "小程序登陆code") private String code; + @ApiModelProperty(value = "分销绑定关系的ID") private String spread; + @ApiModelProperty(value = "小程序完整用户信息的加密数据") private String encryptedData; + @ApiModelProperty(value = "小程序加密算法的初始向量") private String iv; } diff --git a/yshop-app/src/main/java/co/yixiang/modules/auth/param/RegParam.java b/yshop-app/src/main/java/co/yixiang/modules/auth/param/RegParam.java index b5560a78..23c10227 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/auth/param/RegParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/auth/param/RegParam.java @@ -1,5 +1,6 @@ package co.yixiang.modules.auth.param; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import javax.validation.constraints.NotBlank; @@ -11,16 +12,22 @@ import javax.validation.constraints.NotBlank; **/ @Data public class RegParam { + @NotBlank(message = "手机号必填") + @ApiModelProperty(value = "手机号码") private String account; @NotBlank(message = "验证码必填") + @ApiModelProperty(value = "验证码") private String captcha; @NotBlank(message = "密码必填") + @ApiModelProperty(value = "密码") private String password; + @ApiModelProperty(value = "分销绑定关系的ID") private String spread; + @ApiModelProperty(value = "邀请码(预留字段)") private String inviteCode; } diff --git a/yshop-app/src/main/java/co/yixiang/modules/auth/param/VerityParam.java b/yshop-app/src/main/java/co/yixiang/modules/auth/param/VerityParam.java index c96a6904..e03d3bc4 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/auth/param/VerityParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/auth/param/VerityParam.java @@ -1,5 +1,6 @@ package co.yixiang.modules.auth.param; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import javax.validation.constraints.NotBlank; @@ -11,8 +12,11 @@ import javax.validation.constraints.NotBlank; **/ @Data public class VerityParam { + @NotBlank(message = "手机号必填") + @ApiModelProperty(value = "手机号码") private String phone; + @ApiModelProperty(value = "短信类型 bind绑定手机短信 login登陆短信 register注册短信") private String type; } diff --git a/yshop-app/src/main/java/co/yixiang/modules/auth/rest/AuthController.java b/yshop-app/src/main/java/co/yixiang/modules/auth/rest/AuthController.java index 58a2bc52..663f6dab 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/auth/rest/AuthController.java +++ b/yshop-app/src/main/java/co/yixiang/modules/auth/rest/AuthController.java @@ -31,6 +31,8 @@ import com.alibaba.fastjson.JSONObject; import com.aliyuncs.exceptions.ClientException; import com.baomidou.mybatisplus.core.toolkit.Wrappers; import io.swagger.annotations.Api; +import io.swagger.annotations.ApiImplicitParam; +import io.swagger.annotations.ApiImplicitParams; import io.swagger.annotations.ApiOperation; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; @@ -101,6 +103,10 @@ public class AuthController { * 微信公众号授权 */ @GetMapping("/wechat/auth") + @ApiImplicitParams({ + @ApiImplicitParam(name = "code", value = "微信授权code", paramType = "query", dataType = "string"), + @ApiImplicitParam(name = "spread", value = "分销绑定关系的ID", paramType = "query", dataType = "string") + }) @ApiOperation(value = "微信公众号授权", notes = "微信公众号授权") public ApiResult> authLogin(@RequestParam(value = "code") String code, @RequestParam(value = "spread") String spread, diff --git a/yshop-app/src/main/java/co/yixiang/modules/cart/param/CartIdsParm.java b/yshop-app/src/main/java/co/yixiang/modules/cart/param/CartIdsParm.java index e93f7b7d..5c401a85 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/cart/param/CartIdsParm.java +++ b/yshop-app/src/main/java/co/yixiang/modules/cart/param/CartIdsParm.java @@ -1,5 +1,6 @@ package co.yixiang.modules.cart.param; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import javax.validation.constraints.NotNull; @@ -12,6 +13,8 @@ import java.util.List; **/ @Data public class CartIdsParm { + @NotNull(message = "参数有误") + @ApiModelProperty(value = "购物车ID，多个用,分隔开") List ids; } diff --git a/yshop-app/src/main/java/co/yixiang/modules/cart/param/CartNumParam.java b/yshop-app/src/main/java/co/yixiang/modules/cart/param/CartNumParam.java index f0bd125c..cfead9b1 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/cart/param/CartNumParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/cart/param/CartNumParam.java @@ -1,5 +1,6 @@ package co.yixiang.modules.cart.param; +import io.swagger.annotations.ApiModelProperty; import lombok.Getter; import lombok.Setter; @@ -15,10 +16,14 @@ import javax.validation.constraints.NotNull; @Getter @Setter public class CartNumParam { + @Min(value = 1,message = "数量不在合法范围内") @Max(value = 9999,message = "数量不在合法范围内") + @ApiModelProperty(value = "购物车数量") private Integer number; + @NotNull(message = "参数有误") + @ApiModelProperty(value = "购物车ID") private Long id; } diff --git a/yshop-app/src/main/java/co/yixiang/modules/cart/param/CartParam.java b/yshop-app/src/main/java/co/yixiang/modules/cart/param/CartParam.java index 15ea7ecd..8903c0c6 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/cart/param/CartParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/cart/param/CartParam.java @@ -1,6 +1,7 @@ package co.yixiang.modules.cart.param; import com.fasterxml.jackson.annotation.JsonProperty; +import io.swagger.annotations.ApiModelProperty; import lombok.Getter; import lombok.Setter; @@ -16,17 +17,30 @@ import javax.validation.constraints.NotNull; @Getter @Setter public class CartParam { + @Min(value = 1,message = "数量不在合法范围内") @Max(value = 9999,message = "数量不在合法范围内") + @ApiModelProperty(value = "购物车数量") private Integer cartNum; + @JsonProperty(value = "new") + @ApiModelProperty(value = "是否新购买") private Integer isNew = 0; + @NotNull(message = "参数有误") + @ApiModelProperty(value = "产品ID") private Long productId; + //@NotBlank(message = "参数有误") + @ApiModelProperty(value = "唯一的ID") private String uniqueId; + @ApiModelProperty(value = "产品拼团ID") private Long combinationId; + + @ApiModelProperty(value = "产品秒杀ID") private Long secKillId; + + @ApiModelProperty(value = "产品砍价ID") private Long bargainId; } diff --git a/yshop-app/src/main/java/co/yixiang/modules/coupon/param/YxStoreCouponQueryParam.java b/yshop-app/src/main/java/co/yixiang/modules/coupon/param/YxStoreCouponQueryParam.java index a6544d8c..613ddbf4 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/coupon/param/YxStoreCouponQueryParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/coupon/param/YxStoreCouponQueryParam.java @@ -2,6 +2,7 @@ package co.yixiang.modules.coupon.param; import co.yixiang.common.web.param.QueryParam; import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import lombok.EqualsAndHashCode; @@ -22,5 +23,6 @@ public class YxStoreCouponQueryParam extends QueryParam { private static final long serialVersionUID = 1L; @NotBlank(message = "参数有误") + @ApiModelProperty(value = "优惠券ID") private String couponId; } diff --git a/yshop-app/src/main/java/co/yixiang/modules/coupon/rest/CouponController.java b/yshop-app/src/main/java/co/yixiang/modules/coupon/rest/CouponController.java index 3d6310fd..6569b84d 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/coupon/rest/CouponController.java +++ b/yshop-app/src/main/java/co/yixiang/modules/coupon/rest/CouponController.java @@ -21,6 +21,8 @@ import co.yixiang.modules.activity.vo.YxStoreCouponIssueQueryVo; import co.yixiang.modules.activity.vo.YxStoreCouponUserQueryVo; import co.yixiang.modules.coupon.param.YxStoreCouponQueryParam; import io.swagger.annotations.Api; +import io.swagger.annotations.ApiImplicitParam; +import io.swagger.annotations.ApiImplicitParams; import io.swagger.annotations.ApiOperation; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; @@ -57,6 +59,12 @@ public class CouponController { */ @AuthCheck @GetMapping("/coupons") + @ApiImplicitParams({ + @ApiImplicitParam(name = "page", value = "页码,默认为1", paramType = "query", dataType = "int"), + @ApiImplicitParam(name = "limit", value = "页大小,默认为10", paramType = "query", dataType = "int"), + @ApiImplicitParam(name = "productId", value = "产品ID", paramType = "query", dataType = "int"), + @ApiImplicitParam(name = "type", value = "优惠券类型 0通用券 1商品券 2内部券", paramType = "query", dataType = "int") + }) @ApiOperation(value = "可领取优惠券列表",notes = "可领取优惠券列表") public ApiResult> getList(@RequestParam(value = "page",defaultValue = "1") int page, @RequestParam(value = "limit",defaultValue = "10") int limit, @@ -100,6 +108,9 @@ public class CouponController { */ @AuthCheck @GetMapping("/coupons/order/{cartIds}") + @ApiImplicitParams({ + @ApiImplicitParam(name = "cartIds", value = "购物车ID,多个用,分割", paramType = "query", dataType = "int") + }) @ApiOperation(value = "优惠券订单获取",notes = "优惠券订单获取") public ApiResult> orderCoupon(@PathVariable String cartIds){ Long uid = LocalUser.getUser().getUid(); diff --git a/yshop-app/src/main/java/co/yixiang/modules/manage/param/OrderPriceParam.java b/yshop-app/src/main/java/co/yixiang/modules/manage/param/OrderPriceParam.java index e143179d..23013379 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/manage/param/OrderPriceParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/manage/param/OrderPriceParam.java @@ -1,5 +1,6 @@ package co.yixiang.modules.manage.param; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import javax.validation.constraints.NotBlank; @@ -12,8 +13,12 @@ import java.io.Serializable; **/ @Data public class OrderPriceParam implements Serializable { + @NotBlank(message = "订单编号错误") + @ApiModelProperty(value = "订单ID") private String orderId; + @NotBlank(message = "修改价格必填") + @ApiModelProperty(value = "商品价格") private String price; } diff --git a/yshop-app/src/main/java/co/yixiang/modules/manage/param/OrderRemarkParam.java b/yshop-app/src/main/java/co/yixiang/modules/manage/param/OrderRemarkParam.java index 59851966..96d6fc53 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/manage/param/OrderRemarkParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/manage/param/OrderRemarkParam.java @@ -1,5 +1,6 @@ package co.yixiang.modules.manage.param; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import javax.validation.constraints.NotBlank; @@ -12,8 +13,12 @@ import java.io.Serializable; **/ @Data public class OrderRemarkParam implements Serializable { + @NotBlank(message = "订单编号错误") + @ApiModelProperty(value = "订单ID") private String orderId; + @NotBlank(message = "备注必填") + @ApiModelProperty(value = "备注") private String remark; } diff --git a/yshop-app/src/main/java/co/yixiang/modules/manage/param/ShoperQueryParam.java b/yshop-app/src/main/java/co/yixiang/modules/manage/param/ShoperQueryParam.java index a1b92d2d..b2b20645 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/manage/param/ShoperQueryParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/manage/param/ShoperQueryParam.java @@ -2,6 +2,7 @@ package co.yixiang.modules.manage.param; import co.yixiang.common.web.param.QueryParam; import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import lombok.EqualsAndHashCode; @@ -15,8 +16,10 @@ import lombok.EqualsAndHashCode; public class ShoperQueryParam extends QueryParam { private static final long serialVersionUID = 1L; + @ApiModelProperty(value = "商品状态,默认为0未支付 1待发货 2待收货 3待评价 4已完成 5退款中 6已退款 7退款") private Integer status = 0; + @ApiModelProperty(value = "分类") private Integer cate = 1; private Integer type = 1; diff --git a/yshop-app/src/main/java/co/yixiang/modules/manage/rest/ShoperController.java b/yshop-app/src/main/java/co/yixiang/modules/manage/rest/ShoperController.java index ac9ae8d4..2294c61d 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/manage/rest/ShoperController.java +++ b/yshop-app/src/main/java/co/yixiang/modules/manage/rest/ShoperController.java @@ -24,6 +24,8 @@ import co.yixiang.modules.order.vo.ShoperOrderTimeDataVo; import co.yixiang.modules.order.vo.UserOrderCountVo; import co.yixiang.modules.order.vo.YxStoreOrderQueryVo; import io.swagger.annotations.Api; +import io.swagger.annotations.ApiImplicitParam; +import io.swagger.annotations.ApiImplicitParams; import io.swagger.annotations.ApiOperation; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; @@ -75,6 +77,10 @@ public class ShoperController { */ @AuthCheck @GetMapping("/admin/order/data") + @ApiImplicitParams({ + @ApiImplicitParam(name = "page", value = "页码,默认为1", paramType = "query", dataType = "int"), + @ApiImplicitParam(name = "limit", value = "页大小,默认为10", paramType = "query", dataType = "int") + }) @ApiOperation(value = "订单每月统计数据",notes = "订单每月统计数据") public ApiResult> data(@RequestParam(value = "page",defaultValue = "1") int page, @RequestParam(value = "limit",defaultValue = "10") int limit){ diff --git a/yshop-app/src/main/java/co/yixiang/modules/order/dto/OrderExtendDto.java b/yshop-app/src/main/java/co/yixiang/modules/order/dto/OrderExtendDto.java index 631614a5..d6b84cb3 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/order/dto/OrderExtendDto.java +++ b/yshop-app/src/main/java/co/yixiang/modules/order/dto/OrderExtendDto.java @@ -1,5 +1,6 @@ package co.yixiang.modules.order.dto; +import io.swagger.annotations.ApiModelProperty; import lombok.AllArgsConstructor; import lombok.Builder; import lombok.Data; @@ -18,7 +19,13 @@ import java.util.Map; @NoArgsConstructor @Builder public class OrderExtendDto implements Serializable { + + @ApiModelProperty(value = "唯一的key") private String key; + + @ApiModelProperty(value = "订单ID") private String orderId; + + @ApiModelProperty(value = "微信相关配置") private Map jsConfig; } diff --git a/yshop-app/src/main/java/co/yixiang/modules/order/param/ComputeOrderParam.java b/yshop-app/src/main/java/co/yixiang/modules/order/param/ComputeOrderParam.java index cc70bc36..58d48a8b 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/order/param/ComputeOrderParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/order/param/ComputeOrderParam.java @@ -1,6 +1,7 @@ package co.yixiang.modules.order.param; import com.fasterxml.jackson.annotation.JsonProperty; +import io.swagger.annotations.ApiModelProperty; import lombok.Getter; import lombok.Setter; import lombok.ToString; @@ -15,14 +16,29 @@ import lombok.ToString; @ToString public class ComputeOrderParam { //@NotBlank(message = "请选择地址") + @ApiModelProperty(value = "地址ID") private String addressId; + + @ApiModelProperty(value = "优惠券ID") private String couponId; + //@NotBlank(message = "请选择支付方式") + @ApiModelProperty(value = "支付方式") private String payType; + + @ApiModelProperty(value = "使用积分 1-表示使用") private String useIntegral; + @JsonProperty(value = "shipping_type") + @ApiModelProperty(value = "配送方式 1=快递 ，2=门店自提") private String shippingType; + + @ApiModelProperty(value = "砍价ID") private String bargainId; + + @ApiModelProperty(value = "拼团ID") private String pinkId; + + @ApiModelProperty(value = "拼团ID") private String combinationId; } diff --git a/yshop-app/src/main/java/co/yixiang/modules/order/param/ConfirmOrderParam.java b/yshop-app/src/main/java/co/yixiang/modules/order/param/ConfirmOrderParam.java index 5aa74360..23c8b511 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/order/param/ConfirmOrderParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/order/param/ConfirmOrderParam.java @@ -1,5 +1,6 @@ package co.yixiang.modules.order.param; +import io.swagger.annotations.ApiModelProperty; import lombok.Getter; import lombok.Setter; @@ -13,6 +14,8 @@ import javax.validation.constraints.NotBlank; @Getter @Setter public class ConfirmOrderParam { + @NotBlank(message = "请提交购买的商品") + @ApiModelProperty(value = "购物车ID") private String cartId; } diff --git a/yshop-app/src/main/java/co/yixiang/modules/order/param/DoOrderParam.java b/yshop-app/src/main/java/co/yixiang/modules/order/param/DoOrderParam.java index 8c8bdf58..2134cfb7 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/order/param/DoOrderParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/order/param/DoOrderParam.java @@ -1,5 +1,6 @@ package co.yixiang.modules.order.param; +import io.swagger.annotations.ApiModelProperty; import lombok.Getter; import lombok.Setter; @@ -14,5 +15,6 @@ import javax.validation.constraints.NotBlank; @Setter public class DoOrderParam { @NotBlank(message = "参数有误") + @ApiModelProperty(value = "订单ID") private String uni; } diff --git a/yshop-app/src/main/java/co/yixiang/modules/order/param/ExpressParam.java b/yshop-app/src/main/java/co/yixiang/modules/order/param/ExpressParam.java index 8bcd7ffb..4e92f770 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/order/param/ExpressParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/order/param/ExpressParam.java @@ -1,5 +1,6 @@ package co.yixiang.modules.order.param; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.io.Serializable; @@ -11,8 +12,13 @@ import java.io.Serializable; **/ @Data public class ExpressParam implements Serializable { - //@NotBlank() + + @ApiModelProperty(value = "订单编号") private String orderCode; + + @ApiModelProperty(value = "快递公司编码") private String shipperCode; + + @ApiModelProperty(value = "物流单号") private String logisticCode; } diff --git a/yshop-app/src/main/java/co/yixiang/modules/order/param/HandleOrderParam.java b/yshop-app/src/main/java/co/yixiang/modules/order/param/HandleOrderParam.java index e0fb769b..a94a8376 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/order/param/HandleOrderParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/order/param/HandleOrderParam.java @@ -1,5 +1,6 @@ package co.yixiang.modules.order.param; +import io.swagger.annotations.ApiModelProperty; import lombok.Getter; import lombok.Setter; @@ -13,6 +14,8 @@ import javax.validation.constraints.NotBlank; @Getter @Setter public class HandleOrderParam { + @NotBlank(message = "参数有误") + @ApiModelProperty(value = "订单ID") private String id; } diff --git a/yshop-app/src/main/java/co/yixiang/modules/order/param/OrderDeliveryParam.java b/yshop-app/src/main/java/co/yixiang/modules/order/param/OrderDeliveryParam.java index babf87c0..3f5311b6 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/order/param/OrderDeliveryParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/order/param/OrderDeliveryParam.java @@ -1,5 +1,6 @@ package co.yixiang.modules.order.param; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import javax.validation.constraints.NotBlank; @@ -12,12 +13,20 @@ import java.io.Serializable; **/ @Data public class OrderDeliveryParam implements Serializable { + @NotBlank(message = "订单编号错误") + @ApiModelProperty(value = "订单ID") private String orderId; + @NotBlank(message = "快递单号必填") + @ApiModelProperty(value = "快递单号") private String deliveryId; + @NotBlank(message = "快递公司必填") + @ApiModelProperty(value = "快递公司") private String deliveryName; + @NotBlank(message = "快递方式必填") + @ApiModelProperty(value = "快递方式") private String deliveryType; } diff --git a/yshop-app/src/main/java/co/yixiang/modules/order/param/OrderRefundParam.java b/yshop-app/src/main/java/co/yixiang/modules/order/param/OrderRefundParam.java index 98c59b17..0609384b 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/order/param/OrderRefundParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/order/param/OrderRefundParam.java @@ -1,5 +1,6 @@ package co.yixiang.modules.order.param; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import javax.validation.constraints.NotBlank; @@ -13,10 +14,16 @@ import java.io.Serializable; **/ @Data public class OrderRefundParam implements Serializable { + @NotBlank(message = "订单编号错误") + @ApiModelProperty(value = "订单ID") private String orderId; + @NotNull(message = "退款金额必填") + @ApiModelProperty(value = "退款金额") private String price; + @NotNull(message = "参数错误") + @ApiModelProperty(value = "类型：1同意 2拒绝") private Integer type; } diff --git a/yshop-app/src/main/java/co/yixiang/modules/order/param/OrderVerifyParam.java b/yshop-app/src/main/java/co/yixiang/modules/order/param/OrderVerifyParam.java index 1b748def..f5951f75 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/order/param/OrderVerifyParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/order/param/OrderVerifyParam.java @@ -1,5 +1,6 @@ package co.yixiang.modules.order.param; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import javax.validation.constraints.NotBlank; @@ -13,8 +14,11 @@ import java.io.Serializable; @Data public class OrderVerifyParam implements Serializable { + @ApiModelProperty(value = "订单核销状态：1确认0正常") private Integer isConfirm; + @NotBlank(message = "缺少核销码") + @ApiModelProperty(value = "核销码") private String verifyCode; } diff --git a/yshop-app/src/main/java/co/yixiang/modules/order/param/PayParam.java b/yshop-app/src/main/java/co/yixiang/modules/order/param/PayParam.java index e3796081..f94b5525 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/order/param/PayParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/order/param/PayParam.java @@ -1,5 +1,6 @@ package co.yixiang.modules.order.param; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import javax.validation.constraints.NotBlank; @@ -12,9 +13,15 @@ import java.io.Serializable; **/ @Data public class PayParam implements Serializable { + + @ApiModelProperty(value = "来源") private String from; + @NotBlank(message = "选择支付类型") + @ApiModelProperty(value = "支付类型") private String paytype; + @NotBlank(message = "参数错误") + @ApiModelProperty(value = "订单ID") private String uni; } diff --git a/yshop-app/src/main/java/co/yixiang/modules/order/param/ProductOrderParam.java b/yshop-app/src/main/java/co/yixiang/modules/order/param/ProductOrderParam.java index 43edcc92..ba8c701a 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/order/param/ProductOrderParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/order/param/ProductOrderParam.java @@ -1,5 +1,6 @@ package co.yixiang.modules.order.param; +import io.swagger.annotations.ApiModelProperty; import lombok.Getter; import lombok.Setter; @@ -13,6 +14,8 @@ import javax.validation.constraints.NotBlank; @Getter @Setter public class ProductOrderParam { + @NotBlank(message = "参数有误") + @ApiModelProperty(value = "订单唯一值") private String unique; } diff --git a/yshop-app/src/main/java/co/yixiang/modules/order/param/ProductReplyParam.java b/yshop-app/src/main/java/co/yixiang/modules/order/param/ProductReplyParam.java index 6cd07303..aed404cc 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/order/param/ProductReplyParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/order/param/ProductReplyParam.java @@ -1,5 +1,6 @@ package co.yixiang.modules.order.param; +import io.swagger.annotations.ApiModelProperty; import lombok.Getter; import lombok.Setter; @@ -14,14 +15,24 @@ import javax.validation.constraints.Size; @Getter @Setter public class ProductReplyParam { + @NotBlank(message = "评论不能为空") @Size(min = 1, max = 200,message = "长度超过了限制") + @ApiModelProperty(value = "商品评论内容") private String comment; + + @ApiModelProperty(value = "商品评论图片地址") private String pics; + @NotBlank(message = "请为商品评分") + @ApiModelProperty(value = "商品评分") private String productScore; + @NotBlank(message = "请为商品评分") + @ApiModelProperty(value = "服务评分") private String serviceScore; + @NotBlank(message = "参数有误") + @ApiModelProperty(value = "订单唯一值") private String unique; } diff --git a/yshop-app/src/main/java/co/yixiang/modules/order/param/RefundParam.java b/yshop-app/src/main/java/co/yixiang/modules/order/param/RefundParam.java index f797f59b..e3f1e74d 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/order/param/RefundParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/order/param/RefundParam.java @@ -1,6 +1,7 @@ package co.yixiang.modules.order.param; import com.fasterxml.jackson.annotation.JsonProperty; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import javax.validation.constraints.NotBlank; @@ -13,12 +14,20 @@ import java.io.Serializable; **/ @Data public class RefundParam implements Serializable { + @JsonProperty(value = "refund_reason_wap_explain") - private String refundReasonWapExplain; //备注 + @ApiModelProperty(value = "退款备注") + private String refundReasonWapExplain; + @JsonProperty(value = "refund_reason_wap_img") - private String refundReasonWapImg; //图片 + @ApiModelProperty(value = "退款图片") + private String refundReasonWapImg; + @NotBlank(message = "请填写退款原因") + @ApiModelProperty(value = "退款原因") private String text; + @NotBlank(message = "参数错误") + @ApiModelProperty(value = "订单唯一值") private String uni; } diff --git a/yshop-app/src/main/java/co/yixiang/modules/order/rest/StoreOrderController.java b/yshop-app/src/main/java/co/yixiang/modules/order/rest/StoreOrderController.java index f024faf1..41e8252d 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/order/rest/StoreOrderController.java +++ b/yshop-app/src/main/java/co/yixiang/modules/order/rest/StoreOrderController.java @@ -44,6 +44,9 @@ import co.yixiang.tools.express.config.ExpressAutoConfiguration; import co.yixiang.tools.express.dao.ExpressInfo; import com.vdurmont.emoji.EmojiParser; import io.swagger.annotations.Api; +import io.swagger.annotations.ApiImplicitParam; +import io.swagger.annotations.ApiImplicitParams; +import io.swagger.annotations.ApiModelProperty; import io.swagger.annotations.ApiOperation; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; @@ -104,6 +107,9 @@ public class StoreOrderController { */ @AuthCheck @PostMapping("/order/computed/{key}") + @ApiImplicitParams({ + @ApiImplicitParam(name = "key", value = "唯一的key", paramType = "query", dataType = "string") + }) @ApiOperation(value = "计算订单金额",notes = "计算订单金额") public ApiResult> computedOrder(@Validated @RequestBody ComputeOrderParam param, @PathVariable String key){ @@ -214,6 +220,11 @@ public class StoreOrderController { */ @AuthCheck @GetMapping("/order/list") + @ApiImplicitParams({ + @ApiImplicitParam(name = "type", value = "商品状态,默认为0未支付 1待发货 2待收货 3待评价 4已完成 5退款中 6已退款 7退款", paramType = "query", dataType = "int"), + @ApiImplicitParam(name = "page", value = "页码,默认为1", paramType = "query", dataType = "int"), + @ApiImplicitParam(name = "limit", value = "页大小,默认为10", paramType = "query", dataType = "int") + }) @ApiOperation(value = "订单列表",notes = "订单列表") public ApiResult> orderList(@RequestParam(value = "type",defaultValue = "0") int type, @RequestParam(value = "page",defaultValue = "1") int page, @@ -228,6 +239,9 @@ public class StoreOrderController { */ @AuthCheck @GetMapping("/order/detail/{key}") + @ApiImplicitParams({ + @ApiImplicitParam(name = "key", value = "唯一的key", paramType = "query", dataType = "string") + }) @ApiOperation(value = "订单详情",notes = "订单详情") public ApiResult detail(@PathVariable String key){ Long uid = LocalUser.getUser().getUid(); diff --git a/yshop-app/src/main/java/co/yixiang/modules/product/param/YxStoreProductRelationQueryParam.java b/yshop-app/src/main/java/co/yixiang/modules/product/param/YxStoreProductRelationQueryParam.java index 61566af0..6fc22a32 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/product/param/YxStoreProductRelationQueryParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/product/param/YxStoreProductRelationQueryParam.java @@ -1,5 +1,7 @@ package co.yixiang.modules.product.param; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Getter; import lombok.Setter; @@ -15,10 +17,13 @@ import javax.validation.constraints.NotBlank; */ @Getter @Setter +@ApiModel("查询参数对象") public class YxStoreProductRelationQueryParam { @NotBlank(message = "参数有误") + @ApiModelProperty(value = "商品id",required=true) private String id; + @ApiModelProperty(value = "某种类型的商品(普通商品、秒杀商品)") private String category; } diff --git a/yshop-app/src/main/java/co/yixiang/modules/product/rest/StoreProductController.java b/yshop-app/src/main/java/co/yixiang/modules/product/rest/StoreProductController.java index 0a327355..78958ac5 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/product/rest/StoreProductController.java +++ b/yshop-app/src/main/java/co/yixiang/modules/product/rest/StoreProductController.java @@ -39,6 +39,8 @@ import co.yixiang.modules.shop.service.YxSystemAttachmentService; import co.yixiang.modules.shop.service.YxSystemConfigService; import co.yixiang.modules.user.domain.YxUser; import io.swagger.annotations.Api; +import io.swagger.annotations.ApiImplicitParam; +import io.swagger.annotations.ApiImplicitParams; import io.swagger.annotations.ApiOperation; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; @@ -87,6 +89,9 @@ public class StoreProductController { * 获取首页更多产品 */ @GetMapping("/groom/list/{type}") + @ApiImplicitParams({ + @ApiImplicitParam(name = "type", value = "类型：1精品推荐，2热门榜单，3首发新品，4促销单品", paramType = "query", dataType = "int") + }) @ApiOperation(value = "获取首页更多产品",notes = "获取首页更多产品") public ApiResult> moreGoodsList(@PathVariable Integer type){ Map map = new LinkedHashMap<>(); @@ -127,6 +132,9 @@ public class StoreProductController { */ @AuthCheck @GetMapping("/product/poster/{id}") + @ApiImplicitParams({ + @ApiImplicitParam(name = "id", value = "商品ID", paramType = "query", dataType = "int") + }) @ApiOperation(value = "商品详情海报",notes = "商品详情海报") public ApiResult prodoctPoster(@PathVariable Integer id) throws IOException, FontFormatException { YxUser userInfo = LocalUser.getUser(); @@ -192,6 +200,12 @@ public class StoreProductController { */ @AuthCheck @GetMapping("/product/detail/{id}") + @ApiImplicitParams({ + @ApiImplicitParam(name = "id", value = "商品ID", paramType = "query", dataType = "long",required = true), + @ApiImplicitParam(name = "latitude", value = "纬度", paramType = "query", dataType = "string"), + @ApiImplicitParam(name = "longitude", value = "经度", paramType = "query", dataType = "string"), + @ApiImplicitParam(name = "from", value = "来自:", paramType = "query", dataType = "string") + }) @ApiOperation(value = "普通商品详情",notes = "普通商品详情") public ApiResult detail(@PathVariable long id, @RequestParam(value = "",required=false) String latitude, @@ -235,6 +249,12 @@ public class StoreProductController { * 获取产品评论 */ @GetMapping("/reply/list/{id}") + @ApiImplicitParams({ + @ApiImplicitParam(name = "id", value = "商品ID", paramType = "query", dataType = "long",required = true), + @ApiImplicitParam(name = "type", value = "评论分数类型", paramType = "query", dataType = "int"), + @ApiImplicitParam(name = "page", value = "页码,默认为1", paramType = "query", dataType = "int"), + @ApiImplicitParam(name = "limit", value = "页大小,默认为10", paramType = "query", dataType = "int") + }) @ApiOperation(value = "获取产品评论",notes = "获取产品评论") public ApiResult> replyList(@PathVariable Long id, @RequestParam(value = "type",defaultValue = "0") int type, @@ -247,6 +267,9 @@ public class StoreProductController { * 获取产品评论数据 */ @GetMapping("/reply/config/{id}") + @ApiImplicitParams({ + @ApiImplicitParam(name = "id", value = "商品ID", paramType = "query", dataType = "int") + }) @ApiOperation(value = "获取产品评论数据",notes = "获取产品评论数据") public ApiResult replyCount(@PathVariable Integer id){ return ApiResult.ok(replyService.getReplyCount(id)); diff --git a/yshop-app/src/main/java/co/yixiang/modules/shop/param/YxSystemStoreQueryParam.java b/yshop-app/src/main/java/co/yixiang/modules/shop/param/YxSystemStoreQueryParam.java index a7908c9c..a981167a 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/shop/param/YxSystemStoreQueryParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/shop/param/YxSystemStoreQueryParam.java @@ -2,6 +2,7 @@ package co.yixiang.modules.shop.param; import co.yixiang.common.web.param.QueryParam; import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import lombok.EqualsAndHashCode; /** @@ -18,8 +19,10 @@ import lombok.EqualsAndHashCode; public class YxSystemStoreQueryParam extends QueryParam { private static final long serialVersionUID = 1L; + @ApiModelProperty(value = "纬度") private String latitude; + @ApiModelProperty(value = "经度") private String longitude; } diff --git a/yshop-app/src/main/java/co/yixiang/modules/user/param/PromParam.java b/yshop-app/src/main/java/co/yixiang/modules/user/param/PromParam.java index aa592b1e..28ce237e 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/user/param/PromParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/user/param/PromParam.java @@ -1,5 +1,6 @@ package co.yixiang.modules.user.param; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.io.Serializable; @@ -11,9 +12,19 @@ import java.io.Serializable; **/ @Data public class PromParam implements Serializable { + + @ApiModelProperty(value = "推荐人级别 0一级推荐人 1二级推荐人") private Integer grade; + + @ApiModelProperty(value = "关键字搜索") private String keyword; + + @ApiModelProperty(value = "页码") private Integer limit; + + @ApiModelProperty(value = "页大小") private Integer page; + + @ApiModelProperty(value = "排序") private String sort; } diff --git a/yshop-app/src/main/java/co/yixiang/modules/user/param/RechargeParam.java b/yshop-app/src/main/java/co/yixiang/modules/user/param/RechargeParam.java index 80edb32a..fa80e1c2 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/user/param/RechargeParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/user/param/RechargeParam.java @@ -1,6 +1,7 @@ package co.yixiang.modules.user.param; import com.fasterxml.jackson.annotation.JsonProperty; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import javax.validation.constraints.NotBlank; @@ -16,16 +17,21 @@ public class RechargeParam implements Serializable { @NotBlank(message = "充值参数有误") @JsonProperty(value = "rechar_id") + @ApiModelProperty(value = "用户充值ID") private String recharId; + @ApiModelProperty(value = "来源") private String from; //@NotNull(message = "金额必填") // @Min(value = 1,message = "充值金额不能低于1") + @ApiModelProperty(value = "充值金额") private Double price; @JsonProperty(value = "paid_price") + @ApiModelProperty(value = "赠送金额") private Double paidPrice; + @ApiModelProperty(value = "充值单号") private String orderSn; } diff --git a/yshop-app/src/main/java/co/yixiang/modules/user/param/UserEditParam.java b/yshop-app/src/main/java/co/yixiang/modules/user/param/UserEditParam.java index 8aa0ea36..6e086239 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/user/param/UserEditParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/user/param/UserEditParam.java @@ -1,5 +1,6 @@ package co.yixiang.modules.user.param; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import javax.validation.constraints.NotBlank; @@ -13,11 +14,14 @@ import java.io.Serializable; **/ @Data public class UserEditParam implements Serializable { + @NotBlank(message = "请上传头像") + @ApiModelProperty(value = "用户头像") private String avatar; @NotBlank(message = "请填写昵称") @Size(min = 1, max = 60,message = "长度超过了限制") + @ApiModelProperty(value = "用户昵称") private String nickname; diff --git a/yshop-app/src/main/java/co/yixiang/modules/user/rest/UserBillController.java b/yshop-app/src/main/java/co/yixiang/modules/user/rest/UserBillController.java index 4b87b5ed..5e949cd7 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/user/rest/UserBillController.java +++ b/yshop-app/src/main/java/co/yixiang/modules/user/rest/UserBillController.java @@ -27,6 +27,8 @@ import co.yixiang.modules.user.service.YxUserService; import co.yixiang.modules.user.vo.YxUserBillQueryVo; import com.google.common.collect.Maps; import io.swagger.annotations.Api; +import io.swagger.annotations.ApiImplicitParam; +import io.swagger.annotations.ApiImplicitParams; import io.swagger.annotations.ApiOperation; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; @@ -92,6 +94,10 @@ public class UserBillController { */ @AuthCheck @GetMapping("/integral/list") + @ApiImplicitParams({ + @ApiImplicitParam(name = "page", value = "页码,默认为1", paramType = "query", dataType = "int"), + @ApiImplicitParam(name = "limit", value = "页大小,默认为10", paramType = "query", dataType = "int") + }) @ApiOperation(value = "积分记录",notes = "积分记录") public ApiResult> userInfo(@RequestParam(value = "page",defaultValue = "1") int page, @RequestParam(value = "limit",defaultValue = "10") int limit){ @@ -106,6 +112,9 @@ public class UserBillController { */ @AuthCheck @GetMapping("/spread/banner") + @ApiImplicitParams({ + @ApiImplicitParam(name = "form", value = "来源", paramType = "query", dataType = "string") + }) @ApiOperation(value = "分销二维码海报生成",notes = "分销二维码海报生成") public ApiResult>> spreadBanner(@RequestParam(value = "",required=false) String form){ YxUser yxUser = LocalUser.getUser(); @@ -157,6 +166,11 @@ public class UserBillController { */ @AuthCheck @GetMapping("/spread/commission/{type}") + @ApiImplicitParams({ + @ApiImplicitParam(name = "page", value = "页码,默认为1", paramType = "query", dataType = "int"), + @ApiImplicitParam(name = "limit", value = "页大小,默认为10", paramType = "query", dataType = "int"), + @ApiImplicitParam(name = "type", value = "类型 0所有 1消费 2充值 3返佣 4提现 5签到积分 6退款 7系统增加 8系统减少", paramType = "query", dataType = "int") + }) @ApiOperation(value = "推广佣金明细",notes = "推广佣金明细") public ApiResult spreadCommission(@RequestParam(value = "page",defaultValue = "1") int page, @RequestParam(value = "limit",defaultValue = "10") int limit, diff --git a/yshop-app/src/main/java/co/yixiang/modules/user/rest/UserController.java b/yshop-app/src/main/java/co/yixiang/modules/user/rest/UserController.java index a4217c88..233aecd9 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/user/rest/UserController.java +++ b/yshop-app/src/main/java/co/yixiang/modules/user/rest/UserController.java @@ -29,6 +29,8 @@ import co.yixiang.modules.user.vo.SignVo; import co.yixiang.modules.user.vo.YxUserQueryVo; import com.google.common.collect.Maps; import io.swagger.annotations.Api; +import io.swagger.annotations.ApiImplicitParam; +import io.swagger.annotations.ApiImplicitParams; import io.swagger.annotations.ApiOperation; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; @@ -107,6 +109,10 @@ public class UserController { */ @AuthCheck @GetMapping("/collect/user") + @ApiImplicitParams({ + @ApiImplicitParam(name = "page", value = "页码,默认为1", paramType = "query", dataType = "int"), + @ApiImplicitParam(name = "limit", value = "页大小,默认为10", paramType = "query", dataType = "int") + }) @ApiOperation(value = "获取收藏产品",notes = "获取收藏产品") public ApiResult> collectUser(@RequestParam(value = "page",defaultValue = "1") int page, @RequestParam(value = "limit",defaultValue = "10") int limit){ @@ -156,6 +162,10 @@ public class UserController { */ @AuthCheck @GetMapping("/sign/list") + @ApiImplicitParams({ + @ApiImplicitParam(name = "page", value = "页码,默认为1", paramType = "query", dataType = "int"), + @ApiImplicitParam(name = "limit", value = "页大小,默认为10", paramType = "query", dataType = "int") + }) @ApiOperation(value = "签到列表",notes = "签到列表") public ApiResult> signList(@RequestParam(value = "page",defaultValue = "1") int page, @RequestParam(value = "limit",defaultValue = "10") int limit){ @@ -168,6 +178,10 @@ public class UserController { */ @AuthCheck @GetMapping("/sign/month") + @ApiImplicitParams({ + @ApiImplicitParam(name = "page", value = "页码,默认为1", paramType = "query", dataType = "int"), + @ApiImplicitParam(name = "limit", value = "页大小,默认为10", paramType = "query", dataType = "int") + }) @ApiOperation(value = "签到列表（年月）",notes = "签到列表（年月）") public ApiResult signMonthList(@RequestParam(value = "page",defaultValue = "1") int page, @RequestParam(value = "limit",defaultValue = "10") int limit){ diff --git a/yshop-app/src/main/java/co/yixiang/modules/wechat/rest/param/BindPhoneParam.java b/yshop-app/src/main/java/co/yixiang/modules/wechat/rest/param/BindPhoneParam.java index b5772d45..4cbb5ec7 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/wechat/rest/param/BindPhoneParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/wechat/rest/param/BindPhoneParam.java @@ -1,5 +1,6 @@ package co.yixiang.modules.wechat.rest.param; +import io.swagger.annotations.ApiModelProperty; import lombok.Getter; import lombok.Setter; @@ -13,9 +14,12 @@ import javax.validation.constraints.NotBlank; @Getter @Setter public class BindPhoneParam { + @NotBlank(message = "验证码必填") + @ApiModelProperty(value = "验证码") private String captcha; @NotBlank(message = "手机号必填") + @ApiModelProperty(value = "手机号码") private String phone; } diff --git a/yshop-app/src/main/java/co/yixiang/modules/wechat/rest/param/WxPhoneParam.java b/yshop-app/src/main/java/co/yixiang/modules/wechat/rest/param/WxPhoneParam.java index e8f4cfcf..586a549a 100644 --- a/yshop-app/src/main/java/co/yixiang/modules/wechat/rest/param/WxPhoneParam.java +++ b/yshop-app/src/main/java/co/yixiang/modules/wechat/rest/param/WxPhoneParam.java @@ -1,5 +1,6 @@ package co.yixiang.modules.wechat.rest.param; +import io.swagger.annotations.ApiModelProperty; import lombok.Getter; import lombok.Setter; @@ -13,10 +14,14 @@ import javax.validation.constraints.NotBlank; @Getter @Setter public class WxPhoneParam { + @NotBlank(message = "code参数缺失") + @ApiModelProperty(value = "小程序登陆code") private String code; + @ApiModelProperty(value = "小程序完整用户信息的加密数据") private String encryptedData; + @ApiModelProperty(value = "小程序加密算法的初始向量") private String iv; } diff --git a/yshop-common/src/main/java/co/yixiang/api/ApiResult.java b/yshop-common/src/main/java/co/yixiang/api/ApiResult.java index 16b53a19..db610db3 100644 --- a/yshop-common/src/main/java/co/yixiang/api/ApiResult.java +++ b/yshop-common/src/main/java/co/yixiang/api/ApiResult.java @@ -11,6 +11,7 @@ package co.yixiang.api; import com.alibaba.fastjson.annotation.JSONField; import com.fasterxml.jackson.annotation.JsonFormat; +import io.swagger.annotations.ApiModelProperty; import lombok.AllArgsConstructor; import lombok.Builder; import lombok.Data; @@ -38,26 +39,31 @@ public class ApiResult implements Serializable { /** * 响应码 */ + @ApiModelProperty(value = "响应码") private int status; /** * 是否成功 */ + @ApiModelProperty(value = "是否成功：成功true，失败false") private boolean success; /** * 响应消息 */ + @ApiModelProperty(value = "响应消息") private String msg; /** * 响应数据 */ + @ApiModelProperty(value = "响应数据") private T data; /** * 响应时间 */ + @ApiModelProperty(value = "响应时间") @JSONField(format = "yyyy-MM-dd HH:mm:ss") @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss",timezone="GMT+8") private Date time; @@ -149,4 +155,4 @@ public class ApiResult implements Serializable { public static ApiResult fail() { return fail(ApiCode.FAIL); } -} \ No newline at end of file +} diff --git a/yshop-mall/src/main/java/co/yixiang/modules/activity/param/UserExtParam.java b/yshop-mall/src/main/java/co/yixiang/modules/activity/param/UserExtParam.java index 105f0138..906c3b3b 100644 --- a/yshop-mall/src/main/java/co/yixiang/modules/activity/param/UserExtParam.java +++ b/yshop-mall/src/main/java/co/yixiang/modules/activity/param/UserExtParam.java @@ -1,5 +1,6 @@ package co.yixiang.modules.activity.param; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import javax.validation.constraints.NotBlank; @@ -13,18 +14,20 @@ import java.io.Serializable; @Data public class UserExtParam implements Serializable { - //支付宝用户名 + @ApiModelProperty(value = "提现支付宝用户名") private String alipayCode; @NotBlank(message = "体现类型不能为空") + @ApiModelProperty(value = "提现类型 weixin alipay") private String extractType; @NotBlank(message = "金额不能为空") + @ApiModelProperty(value = "提现金额") private String money; - //微信号 + @ApiModelProperty(value = "微信号") private String weixin; - //支付宝账号 + @ApiModelProperty(value = "支付宝账号") private String name; } diff --git a/yshop-mall/src/main/java/co/yixiang/modules/activity/service/dto/SeckillTimeDto.java b/yshop-mall/src/main/java/co/yixiang/modules/activity/service/dto/SeckillTimeDto.java index 4eeb8101..e7062f73 100644 --- a/yshop-mall/src/main/java/co/yixiang/modules/activity/service/dto/SeckillTimeDto.java +++ b/yshop-mall/src/main/java/co/yixiang/modules/activity/service/dto/SeckillTimeDto.java @@ -1,5 +1,6 @@ package co.yixiang.modules.activity.service.dto; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; @Data @@ -9,13 +10,18 @@ public class SeckillTimeDto { /** * 00:00 */ + @ApiModelProperty(value = "秒杀产品时间：00:00") private String time; + /** *状态 */ + @ApiModelProperty(value = "秒杀产品状态显示中文值") private String state; + @ApiModelProperty(value = "秒杀产品状态") private Integer status; + @ApiModelProperty(value = "秒杀产品停止时间") private Integer stop; } diff --git a/yshop-mall/src/main/java/co/yixiang/modules/activity/vo/SeckillConfigVo.java b/yshop-mall/src/main/java/co/yixiang/modules/activity/vo/SeckillConfigVo.java index 0df2c628..8c5154db 100644 --- a/yshop-mall/src/main/java/co/yixiang/modules/activity/vo/SeckillConfigVo.java +++ b/yshop-mall/src/main/java/co/yixiang/modules/activity/vo/SeckillConfigVo.java @@ -2,6 +2,7 @@ package co.yixiang.modules.activity.vo; import co.yixiang.modules.activity.service.dto.SeckillTimeDto; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.util.List; @@ -9,10 +10,11 @@ import java.util.List; @Data public class SeckillConfigVo { - + @ApiModelProperty(value = "秒杀产品时间信息") private List seckillTime; private String lovely; + @ApiModelProperty(value = "秒杀产品时间索引") private Integer seckillTimeIndex; } diff --git a/yshop-mall/src/main/java/co/yixiang/modules/activity/vo/StoreCouponUserVo.java b/yshop-mall/src/main/java/co/yixiang/modules/activity/vo/StoreCouponUserVo.java index 57df9ecb..0e85a24f 100644 --- a/yshop-mall/src/main/java/co/yixiang/modules/activity/vo/StoreCouponUserVo.java +++ b/yshop-mall/src/main/java/co/yixiang/modules/activity/vo/StoreCouponUserVo.java @@ -1,6 +1,7 @@ package co.yixiang.modules.activity.vo; import com.fasterxml.jackson.annotation.JsonFormat; +import io.swagger.annotations.ApiModelProperty; import lombok.Getter; import lombok.Setter; @@ -9,7 +10,7 @@ import java.util.Date; /** * 优惠券发放记录对象StoreCouponUserVO - * + * * @author hupeng * @date 2020-05-06 */ @@ -20,23 +21,32 @@ public class StoreCouponUserVo implements Serializable private static final long serialVersionUID = 1L; /** 优惠券发放记录id */ + @ApiModelProperty(value = "优惠券发放记录ID") private Long id; /** 优惠券名称 */ + @ApiModelProperty(value = "优惠券名称") private String couponTitle; /** 优惠券的面值 */ + @ApiModelProperty(value = "优惠券的面值") private Double couponPrice; /** 最低消费多少金额可用优惠券 */ + @ApiModelProperty(value = "最低消费多少金额可用优惠券") private Double useMinPrice; /** 优惠券结束时间 */ @JsonFormat(pattern = "yyyy-MM-dd",timezone="GMT+8") + @ApiModelProperty(value = "优惠券结束时间") private Date endTime; + /** 优惠券类型 0通用券 1商品券 2内部券*/ + @ApiModelProperty(value = "优惠券类型 0通用券 1商品券 2内部券") private Integer type; + /**优惠产品ID*/ + @ApiModelProperty(value = "优惠产品ID") private String productId; diff --git a/yshop-mall/src/main/java/co/yixiang/modules/activity/vo/StoreSeckillVo.java b/yshop-mall/src/main/java/co/yixiang/modules/activity/vo/StoreSeckillVo.java index 8d0afc57..bf5ce8f1 100644 --- a/yshop-mall/src/main/java/co/yixiang/modules/activity/vo/StoreSeckillVo.java +++ b/yshop-mall/src/main/java/co/yixiang/modules/activity/vo/StoreSeckillVo.java @@ -2,6 +2,7 @@ package co.yixiang.modules.activity.vo; import co.yixiang.modules.product.vo.YxStoreProductReplyQueryVo; +import io.swagger.annotations.ApiModelProperty; import lombok.Builder; import lombok.Data; @@ -20,13 +21,17 @@ import java.io.Serializable; public class StoreSeckillVo implements Serializable { private static final long serialVersionUID = 1L; + @ApiModelProperty(value = "秒杀产品评论信息") private YxStoreProductReplyQueryVo reply; + @ApiModelProperty(value = "秒杀产品评论数量") private Integer replyCount; + @ApiModelProperty(value = "秒杀产品信息") private YxStoreSeckillQueryVo storeInfo; @Builder.Default + @ApiModelProperty(value = "秒杀产品用户是否收藏") private Boolean userCollect = false; diff --git a/yshop-mall/src/main/java/co/yixiang/modules/activity/vo/YxStoreBargainQueryVo.java b/yshop-mall/src/main/java/co/yixiang/modules/activity/vo/YxStoreBargainQueryVo.java index ab87d7c5..170c37ed 100644 --- a/yshop-mall/src/main/java/co/yixiang/modules/activity/vo/YxStoreBargainQueryVo.java +++ b/yshop-mall/src/main/java/co/yixiang/modules/activity/vo/YxStoreBargainQueryVo.java @@ -102,7 +102,8 @@ public class YxStoreBargainQueryVo implements Serializable { @ApiModelProperty(value = "砍价产品分享量") private Integer share; - private Integer people; //参与人数 + @ApiModelProperty(value = "砍价产品参与人数") + private Integer people; -} \ No newline at end of file +} diff --git a/yshop-mall/src/main/java/co/yixiang/modules/activity/vo/YxStoreCouponIssueQueryVo.java b/yshop-mall/src/main/java/co/yixiang/modules/activity/vo/YxStoreCouponIssueQueryVo.java index edc3b6f3..54313ff8 100644 --- a/yshop-mall/src/main/java/co/yixiang/modules/activity/vo/YxStoreCouponIssueQueryVo.java +++ b/yshop-mall/src/main/java/co/yixiang/modules/activity/vo/YxStoreCouponIssueQueryVo.java @@ -26,8 +26,10 @@ public class YxStoreCouponIssueQueryVo implements Serializable { @ApiModelProperty(value = "优惠券ID") private Integer cid; + @ApiModelProperty(value = "优惠券名称") private String cname; + @ApiModelProperty(value = "优惠券类别") private Integer ctype; @ApiModelProperty(value = "优惠券领取开启时间") @@ -50,10 +52,13 @@ public class YxStoreCouponIssueQueryVo implements Serializable { @ApiModelProperty(value = "1 正常 0 未开启 -1 已无效") private Integer status; + @ApiModelProperty(value = "优惠券价格") private Double couponPrice; + @ApiModelProperty(value = "优惠券最低满多少能使用") private Double useMinPrice; + @ApiModelProperty(value = "优惠券是否使用") private Boolean isUse; -} \ No newline at end of file +} diff --git a/yshop-mall/src/main/java/co/yixiang/modules/activity/vo/YxStoreCouponUserQueryVo.java b/yshop-mall/src/main/java/co/yixiang/modules/activity/vo/YxStoreCouponUserQueryVo.java index 93512d07..366bf8f3 100644 --- a/yshop-mall/src/main/java/co/yixiang/modules/activity/vo/YxStoreCouponUserQueryVo.java +++ b/yshop-mall/src/main/java/co/yixiang/modules/activity/vo/YxStoreCouponUserQueryVo.java @@ -41,6 +41,7 @@ public class YxStoreCouponUserQueryVo implements Serializable { private BigDecimal useMinPrice; @JsonFormat(pattern = "yyyy-MM-dd",timezone="GMT+8") + @ApiModelProperty(value = "优惠券创建时间") private Date createTime; @ApiModelProperty(value = "优惠券结束时间") @@ -59,8 +60,10 @@ public class YxStoreCouponUserQueryVo implements Serializable { @ApiModelProperty(value = "是否有效") private Integer isFail; + @ApiModelProperty(value = "优惠券发放类型 0可用 1不可用") private Integer _type; + @ApiModelProperty(value = "优惠券发放显示文字") private String _msg; -} \ No newline at end of file +} diff --git a/yshop-mall/src/main/java/co/yixiang/modules/activity/vo/YxStorePinkQueryVo.java b/yshop-mall/src/main/java/co/yixiang/modules/activity/vo/YxStorePinkQueryVo.java index 4f0266f7..e7e78bdc 100644 --- a/yshop-mall/src/main/java/co/yixiang/modules/activity/vo/YxStorePinkQueryVo.java +++ b/yshop-mall/src/main/java/co/yixiang/modules/activity/vo/YxStorePinkQueryVo.java @@ -26,7 +26,10 @@ public class YxStorePinkQueryVo implements Serializable { @ApiModelProperty(value = "用户id") private Long uid; + @ApiModelProperty(value = "用户昵称") private String nickname; + + @ApiModelProperty(value = "用户头像") private String avatar; @ApiModelProperty(value = "订单id 生成") @@ -56,6 +59,7 @@ public class YxStorePinkQueryVo implements Serializable { @ApiModelProperty(value = "开始时间") private Date createTime; + @ApiModelProperty(value = "结束时间") private Date stopTime; @ApiModelProperty(value = "团长id 0为团长") @@ -65,4 +69,4 @@ public class YxStorePinkQueryVo implements Serializable { @ApiModelProperty(value = "状态1进行中2已完成3未完成") private Integer status; -} \ No newline at end of file +} diff --git a/yshop-mall/src/main/java/co/yixiang/modules/activity/vo/YxStoreSeckillQueryVo.java b/yshop-mall/src/main/java/co/yixiang/modules/activity/vo/YxStoreSeckillQueryVo.java index c45c3b0a..84833b75 100644 --- a/yshop-mall/src/main/java/co/yixiang/modules/activity/vo/YxStoreSeckillQueryVo.java +++ b/yshop-mall/src/main/java/co/yixiang/modules/activity/vo/YxStoreSeckillQueryVo.java @@ -101,7 +101,8 @@ public class YxStoreSeckillQueryVo implements Serializable{ @ApiModelProperty(value = "显示") private Integer isShow; - private Integer percent; //百分比 + @ApiModelProperty(value = "百分比") + private Integer percent; diff --git a/yshop-mall/src/main/java/co/yixiang/modules/cart/vo/YxStoreCartQueryVo.java b/yshop-mall/src/main/java/co/yixiang/modules/cart/vo/YxStoreCartQueryVo.java index b32146dc..e6b41e4c 100644 --- a/yshop-mall/src/main/java/co/yixiang/modules/cart/vo/YxStoreCartQueryVo.java +++ b/yshop-mall/src/main/java/co/yixiang/modules/cart/vo/YxStoreCartQueryVo.java @@ -48,19 +48,25 @@ public class YxStoreCartQueryVo implements Serializable { @ApiModelProperty(value = "砍价id") private Long bargainId; + @ApiModelProperty(value = "商品信息") private YxStoreProductQueryVo productInfo; - + @ApiModelProperty(value = "成本价") private Double costPrice; + @ApiModelProperty(value = "真实价格") private Double truePrice; + @ApiModelProperty(value = "真实库存") private Integer trueStock; + @ApiModelProperty(value = "vip真实价格") private Double vipTruePrice; + @ApiModelProperty(value = "唯一id") private String unique; + @ApiModelProperty(value = "是否回复") private Integer isReply; -} \ No newline at end of file +} diff --git a/yshop-mall/src/main/java/co/yixiang/modules/order/param/ExpressParam.java b/yshop-mall/src/main/java/co/yixiang/modules/order/param/ExpressParam.java index 8575abd3..8a7cc4ca 100644 --- a/yshop-mall/src/main/java/co/yixiang/modules/order/param/ExpressParam.java +++ b/yshop-mall/src/main/java/co/yixiang/modules/order/param/ExpressParam.java @@ -5,6 +5,7 @@ */ package co.yixiang.modules.order.param; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.io.Serializable; @@ -16,8 +17,13 @@ import java.io.Serializable; **/ @Data public class ExpressParam implements Serializable { - ////@NotBlank() + + @ApiModelProperty(value = "订单编号") private String orderCode; + + @ApiModelProperty(value = "快递公司编码") private String shipperCode; + + @ApiModelProperty(value = "物流单号") private String logisticCode; } diff --git a/yshop-mall/src/main/java/co/yixiang/modules/order/param/OrderParam.java b/yshop-mall/src/main/java/co/yixiang/modules/order/param/OrderParam.java index ded4cdec..eb5e03b1 100644 --- a/yshop-mall/src/main/java/co/yixiang/modules/order/param/OrderParam.java +++ b/yshop-mall/src/main/java/co/yixiang/modules/order/param/OrderParam.java @@ -1,5 +1,6 @@ package co.yixiang.modules.order.param; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import javax.validation.constraints.NotBlank; @@ -13,23 +14,52 @@ import java.io.Serializable; **/ @Data public class OrderParam implements Serializable { + + @ApiModelProperty(value = "地址ID") private String addressId; + + @ApiModelProperty(value = "砍价产品ID") private String bargainId; + + @ApiModelProperty(value = "拼团ID") private String combinationId; + + @ApiModelProperty(value = "优惠券ID") private String couponId; + + @ApiModelProperty(value = "来源") private String from; @Size(max = 200,message = "长度超过了限制") + @ApiModelProperty(value = "备注") private String mark; + @NotBlank(message="请选择支付方式") + @ApiModelProperty(value = "支付方式") private String payType; + + @ApiModelProperty(value = "门店电话") private String phone; + + @ApiModelProperty(value = "拼团产品ID") private String pinkId; + + @ApiModelProperty(value = "门店联系人") private String realName; + + @ApiModelProperty(value = "秒杀产品ID") private String seckillId; + + @ApiModelProperty(value = "配送方式 1=快递 ，2=门店自提") private String shippingType; + + @ApiModelProperty(value = "使用积分 1-表示使用") private String useIntegral; + + @ApiModelProperty(value = "支付渠道(0微信公众号1微信小程序) ") private String isChannel; + + @ApiModelProperty(value = "门店ID") private String storeId; } diff --git a/yshop-mall/src/main/java/co/yixiang/modules/order/service/dto/ProductAttrDto.java b/yshop-mall/src/main/java/co/yixiang/modules/order/service/dto/ProductAttrDto.java index 23ff5620..68aa6f1a 100644 --- a/yshop-mall/src/main/java/co/yixiang/modules/order/service/dto/ProductAttrDto.java +++ b/yshop-mall/src/main/java/co/yixiang/modules/order/service/dto/ProductAttrDto.java @@ -1,5 +1,6 @@ package co.yixiang.modules.order.service.dto; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.io.Serializable; @@ -11,8 +12,16 @@ import java.io.Serializable; **/ @Data public class ProductAttrDto implements Serializable { + + @ApiModelProperty(value = "产品属性ID") private Long productId; + + @ApiModelProperty(value = "产品属性sku") private String sku; + + @ApiModelProperty(value = "产品属性价格") private Double price; + + @ApiModelProperty(value = "产品属性图片") private String image; } diff --git a/yshop-mall/src/main/java/co/yixiang/modules/order/service/dto/ProductDto.java b/yshop-mall/src/main/java/co/yixiang/modules/order/service/dto/ProductDto.java index e587f975..5d465e78 100644 --- a/yshop-mall/src/main/java/co/yixiang/modules/order/service/dto/ProductDto.java +++ b/yshop-mall/src/main/java/co/yixiang/modules/order/service/dto/ProductDto.java @@ -1,5 +1,6 @@ package co.yixiang.modules.order.service.dto; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.io.Serializable; @@ -11,9 +12,17 @@ import java.io.Serializable; **/ @Data public class ProductDto implements Serializable { + + @ApiModelProperty(value = "产品图片") private String image; + + @ApiModelProperty(value = "产品价格") private Double price; + + @ApiModelProperty(value = "产品名称") private String storeName; + + @ApiModelProperty(value = "产品属性信息") private ProductAttrDto attrInfo; } diff --git a/yshop-mall/src/main/java/co/yixiang/modules/order/vo/OrderCartInfoVo.java b/yshop-mall/src/main/java/co/yixiang/modules/order/vo/OrderCartInfoVo.java index 35fe83ce..a0e0cd9b 100644 --- a/yshop-mall/src/main/java/co/yixiang/modules/order/vo/OrderCartInfoVo.java +++ b/yshop-mall/src/main/java/co/yixiang/modules/order/vo/OrderCartInfoVo.java @@ -1,6 +1,7 @@ package co.yixiang.modules.order.vo; import co.yixiang.modules.order.service.dto.ProductDto; +import io.swagger.annotations.ApiModelProperty; import lombok.Builder; import lombok.Data; @@ -19,25 +20,26 @@ import java.io.Serializable; public class OrderCartInfoVo implements Serializable { private static final long serialVersionUID = 1L; - + @ApiModelProperty(value = "订单ID") private String orderId; - + @ApiModelProperty(value = "商品ID") private Long productId; - + @ApiModelProperty(value = "购物车数量") private Integer cartNum; - + @ApiModelProperty(value = "拼团产品ID") private Long combinationId; + @ApiModelProperty(value = "秒杀产品ID") private Long seckillId; + @ApiModelProperty(value = "砍价产品ID") private Long bargainId; + @ApiModelProperty(value = "产品信息") private ProductDto productInfo; - - -} \ No newline at end of file +} diff --git a/yshop-mall/src/main/java/co/yixiang/modules/order/vo/UserOrderCountVo.java b/yshop-mall/src/main/java/co/yixiang/modules/order/vo/UserOrderCountVo.java index 315a236e..63a1fec9 100644 --- a/yshop-mall/src/main/java/co/yixiang/modules/order/vo/UserOrderCountVo.java +++ b/yshop-mall/src/main/java/co/yixiang/modules/order/vo/UserOrderCountVo.java @@ -1,5 +1,6 @@ package co.yixiang.modules.order.vo; +import io.swagger.annotations.ApiModelProperty; import lombok.AllArgsConstructor; import lombok.Builder; import lombok.Getter; @@ -19,15 +20,36 @@ import java.io.Serializable; @AllArgsConstructor @Builder public class UserOrderCountVo implements Serializable { - //订单支付没有退款 数量 + + /**订单支付没有退款 数量*/ + @ApiModelProperty(value = "订单支付没有退款数量") private Integer orderCount; - //订单支付没有退款 支付总金额 + + /**订单支付没有退款 支付总金额*/ + @ApiModelProperty(value = "订单支付没有退款支付总金额") private Double sumPrice; - //订单待支付 数量 + + /**订单待支付 数量*/ + @ApiModelProperty(value = "订单待支付数量") private Integer unpaidCount; - private Integer unshippedCount; //订单待发货 数量 - private Integer receivedCount; //订单待收货 数量 - private Integer evaluatedCount; //订单待评价 数量 - private Integer completeCount; //订单已完成 数量 - private Integer refundCount; //订单退款 + + /**订单待发货数量*/ + @ApiModelProperty(value = "订单待发货数量") + private Integer unshippedCount; + + /**订单待收货数量*/ + @ApiModelProperty(value = "订单待收货数量") + private Integer receivedCount; + + /**订单待评价数量*/ + @ApiModelProperty(value = "订单待评价数量") + private Integer evaluatedCount; + + /**订单已完成数量*/ + @ApiModelProperty(value = "订单已完成数量") + private Integer completeCount; + + /**订单退款数量*/ + @ApiModelProperty(value = "订单退款数量") + private Integer refundCount; } diff --git a/yshop-mall/src/main/java/co/yixiang/modules/order/vo/YxStoreOrderQueryVo.java b/yshop-mall/src/main/java/co/yixiang/modules/order/vo/YxStoreOrderQueryVo.java index b0f4a73c..c5edb2a4 100644 --- a/yshop-mall/src/main/java/co/yixiang/modules/order/vo/YxStoreOrderQueryVo.java +++ b/yshop-mall/src/main/java/co/yixiang/modules/order/vo/YxStoreOrderQueryVo.java @@ -184,10 +184,13 @@ public class YxStoreOrderQueryVo implements Serializable { private Integer isSystemDel; + @ApiModelProperty(value = "门店信息与二维码链接") private String code; + @ApiModelProperty(value = "腾讯地图key") private String mapKey; + @ApiModelProperty(value = "门店信息") private YxSystemStoreQueryVo systemStore; -} \ No newline at end of file +} diff --git a/yshop-mall/src/main/java/co/yixiang/modules/product/domain/YxStoreProduct.java b/yshop-mall/src/main/java/co/yixiang/modules/product/domain/YxStoreProduct.java index 31045acf..8897fe6c 100644 --- a/yshop-mall/src/main/java/co/yixiang/modules/product/domain/YxStoreProduct.java +++ b/yshop-mall/src/main/java/co/yixiang/modules/product/domain/YxStoreProduct.java @@ -12,6 +12,7 @@ import co.yixiang.modules.category.domain.YxStoreCategory; import com.baomidou.mybatisplus.annotation.TableField; import com.baomidou.mybatisplus.annotation.TableId; import com.baomidou.mybatisplus.annotation.TableName; +import io.swagger.annotations.ApiModelProperty; import lombok.AllArgsConstructor; import lombok.Builder; import lombok.Getter; @@ -41,45 +42,55 @@ public class YxStoreProduct extends BaseDomain { /** 商品id */ @TableId + @ApiModelProperty(value = "商品ID") private Long id; /** 商户Id(0为总后台管理员创建,不为0的时候是商户后台创建) */ + @ApiModelProperty(value = "商户Id(0为总后台管理员创建,不为0的时候是商户后台创建) 预留字段") private Integer merId; /** 商品图片 */ @NotBlank(message = "请上传商品图片") + @ApiModelProperty(value = "商品图片") private String image; /** 轮播图 */ - @NotBlank(message = "请上传商品轮播") + @NotBlank(message = "请上传商品轮播图") + @ApiModelProperty(value = "商品轮播图") private String sliderImage; /** 商品名称 */ @NotBlank(message = "商品名称不能空") + @ApiModelProperty(value = "商品名称") private String storeName; /** 商品简介 */ + @ApiModelProperty(value = "商品简介") private String storeInfo; /** 关键字 */ + @ApiModelProperty(value = "关键字") private String keyword; /** 产品条码（一维码） */ + @ApiModelProperty(value = "产品条码（一维码）") private String barCode; /** 分类id */ + @ApiModelProperty(value = "分类id") private String cateId; /** 商品价格 */ + @ApiModelProperty(value = "商品价格") @NotNull(message = "请输入商品价格") @DecimalMin(value="0.00", message = "商品价格不在合法范围内" ) @DecimalMax(value="99999999.99", message = "商品价格不在合法范围内") @@ -87,10 +98,12 @@ public class YxStoreProduct extends BaseDomain { /** 会员价格 */ + @ApiModelProperty(value = "会员价格") private BigDecimal vipPrice; /** 市场价 */ + @ApiModelProperty(value = "市场价") @NotNull(message = "请输入市场价") @DecimalMin(value="0.00", message = "市场价不在合法范围内" ) @DecimalMax(value="99999999.99", message = "市场价不在合法范围内") @@ -98,69 +111,83 @@ public class YxStoreProduct extends BaseDomain { /** 邮费 */ + @ApiModelProperty(value = "邮费") private BigDecimal postage; /** 单位名 */ @NotBlank(message = "请填写单位") + @ApiModelProperty(value = "单位名") private String unitName; /** 排序 */ + @ApiModelProperty(value = "排序") private Integer sort; /** 销量 */ + @ApiModelProperty(value = "销量") private Integer sales; /** 库存 */ + @ApiModelProperty(value = "库存") @NotNull(message = "请输入库存") @Min(message = "库存不能小于0",value = 1) private Integer stock; /** 状态（0：未上架，1：上架） */ + @ApiModelProperty(value = "状态（0：未上架，1：上架）") private Integer isShow; /** 是否热卖 */ + @ApiModelProperty(value = "是否热卖（0：否，1：是）") private Integer isHot; /** 是否优惠 */ + @ApiModelProperty(value = "是否猜你喜欢（0：否，1：是）") private Integer isBenefit; /** 是否精品 */ + @ApiModelProperty(value = "是否精品（0：否，1：是）") private Integer isBest; /** 是否新品 */ + @ApiModelProperty(value = "是否新品（0：否，1：是）") private Integer isNew; /** 产品描述 */ @NotBlank(message = "请填写商品详情") + @ApiModelProperty(value = "商品详情") private String description; - /** 是否包邮 */ + @ApiModelProperty(value = "是否包邮") private Integer isPostage; /** 商户是否代理 0不可代理1可代理 */ + @ApiModelProperty(value = "商户是否代理 0不可代理1可代理 ") private Integer merUse; /** 获得积分 */ + @ApiModelProperty(value = "获得积分") @DecimalMin(value="0.00", message = "获得积分不在合法范围内" ) @DecimalMax(value="99999999.99", message = "获得积分不在合法范围内") private BigDecimal giveIntegral; /** 成本价 */ + @ApiModelProperty(value = "成本价") @NotNull(message = "请输入成本价") @DecimalMin(value="0.00", message = "成本价不在合法范围内" ) @DecimalMax(value="99999999.99", message = "成本价不在合法范围内") @@ -168,33 +195,41 @@ public class YxStoreProduct extends BaseDomain { /** 秒杀状态 0 未开启 1已开启 */ + @ApiModelProperty(value = "秒杀状态 0 未开启 1已开启") private Integer isSeckill; /** 砍价状态 0未开启 1开启 */ + @ApiModelProperty(value = "砍价状态 0 未开启 1已开启") private Integer isBargain; /** 是否优品推荐 */ + @ApiModelProperty(value = "是否优品推荐（0：否，1：是）") private Integer isGood; /** 虚拟销量 */ + @ApiModelProperty(value = "虚拟销量") private Integer ficti; /** 浏览量 */ + @ApiModelProperty(value = "浏览量") private Integer browse; /** 产品二维码地址(用户小程序海报) */ + @ApiModelProperty(value = "品二维码地址(用户小程序海报) ") private String codePath; - + @ApiModelProperty(value = "邮费模版ID") private Integer tempId; + @ApiModelProperty(value = "规格 0单 1多 ") private Integer specType; + @ApiModelProperty(value = "是否单独分佣") private Integer isSub; @TableField(exist = false) diff --git a/yshop-mall/src/main/java/co/yixiang/modules/product/domain/YxStoreProductAttrValue.java b/yshop-mall/src/main/java/co/yixiang/modules/product/domain/YxStoreProductAttrValue.java index 86c8061e..e40346e2 100644 --- a/yshop-mall/src/main/java/co/yixiang/modules/product/domain/YxStoreProductAttrValue.java +++ b/yshop-mall/src/main/java/co/yixiang/modules/product/domain/YxStoreProductAttrValue.java @@ -10,6 +10,7 @@ import cn.hutool.core.bean.copier.CopyOptions; import com.baomidou.mybatisplus.annotation.TableField; import com.baomidou.mybatisplus.annotation.TableId; import com.baomidou.mybatisplus.annotation.TableName; +import io.swagger.annotations.ApiModelProperty; import lombok.AllArgsConstructor; import lombok.Builder; import lombok.Getter; @@ -37,62 +38,81 @@ public class YxStoreProductAttrValue implements Serializable { /** 商品ID */ + @ApiModelProperty(value = "商品ID") private Long productId; /** 商品属性索引值 (attr_value|attr_value[|....]) */ + @ApiModelProperty(value = "商品属性索引值 (attr_value|attr_value[|....])") private String sku; /** 属性对应的库存 */ + @ApiModelProperty(value = "属性对应的库存") private Integer stock; /** 拼团库存属性对应的库存 */ + @ApiModelProperty(value = "拼团库存属性对应的库存") private Integer pinkStock; /** 秒杀库存属性对应的库存 */ + @ApiModelProperty(value = "秒杀库存属性对应的库存") private Integer seckillStock; /** 销量 */ + @ApiModelProperty(value = "销量") private Integer sales; /** 属性金额 */ + @ApiModelProperty(value = "属性金额") private BigDecimal price; /** 拼团属性对应的金额 */ + @ApiModelProperty(value = "拼团属性对应的金额") private BigDecimal pinkPrice; /** 秒杀属性对应的金额 */ + @ApiModelProperty(value = "秒杀属性对应的金额") private BigDecimal seckillPrice; + /** 图片 */ + @ApiModelProperty(value = "属性对应的图片") private String image; /** 唯一值 */ @TableField(value = "`unique`") + @ApiModelProperty(value = "唯一值") private String unique; /** 成本价 */ + @ApiModelProperty(value = "成本价") private BigDecimal cost; /** 商品条码 */ + @ApiModelProperty(value = "商品条码") private String barCode; /** 原价 */ + @ApiModelProperty(value = "原价") private BigDecimal otPrice; /** 重量 */ + @ApiModelProperty(value = "重量") private BigDecimal weight; /** 体积 */ + @ApiModelProperty(value = "体积") private BigDecimal volume; /** 一级返佣 */ + @ApiModelProperty(value = "一级返佣") private BigDecimal brokerage; /** 二级返佣 */ + @ApiModelProperty(value = "二级返佣") private BigDecimal brokerageTwo; diff --git a/yshop-mall/src/main/java/co/yixiang/modules/product/param/YxStoreProductQueryParam.java b/yshop-mall/src/main/java/co/yixiang/modules/product/param/YxStoreProductQueryParam.java index b5bc604d..0832d2ae 100644 --- a/yshop-mall/src/main/java/co/yixiang/modules/product/param/YxStoreProductQueryParam.java +++ b/yshop-mall/src/main/java/co/yixiang/modules/product/param/YxStoreProductQueryParam.java @@ -2,6 +2,7 @@ package co.yixiang.modules.product.param; import co.yixiang.common.web.param.QueryParam; import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import lombok.EqualsAndHashCode; @@ -19,10 +20,21 @@ import lombok.EqualsAndHashCode; public class YxStoreProductQueryParam extends QueryParam { private static final long serialVersionUID = 1L; + @ApiModelProperty(value = "类别") private String type; + + @ApiModelProperty(value = "分类ID") private String sid; + + @ApiModelProperty(value = "是否新品") private String news; + + @ApiModelProperty(value = "价格排序") private String priceOrder; + + @ApiModelProperty(value = "销量排序") private String salesOrder; + + @ApiModelProperty(value = "关键字") private String keyword; } diff --git a/yshop-mall/src/main/java/co/yixiang/modules/product/vo/ProductVo.java b/yshop-mall/src/main/java/co/yixiang/modules/product/vo/ProductVo.java index 342faf30..abd59808 100644 --- a/yshop-mall/src/main/java/co/yixiang/modules/product/vo/ProductVo.java +++ b/yshop-mall/src/main/java/co/yixiang/modules/product/vo/ProductVo.java @@ -1,6 +1,7 @@ package co.yixiang.modules.product.vo; import co.yixiang.modules.product.domain.YxStoreProductAttrValue; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.util.ArrayList; @@ -21,7 +22,7 @@ public class ProductVo{ private List goodList = new ArrayList(); - + @ApiModelProperty(value = "商户ID，预留字段") private Integer merId = 0; private String priceName = ""; @@ -30,10 +31,13 @@ public class ProductVo{ private Map productValue = new LinkedHashMap<>(); + @ApiModelProperty(value = "评论信息") private YxStoreProductReplyQueryVo reply; + @ApiModelProperty(value = "回复渠道") private String replyChance; + @ApiModelProperty(value = "回复数") private Integer replyCount = 0; //todo @@ -41,13 +45,16 @@ public class ProductVo{ private YxStoreProductQueryVo storeInfo; + @ApiModelProperty(value = "腾讯地图key") private String mapKey; - //门店 + @ApiModelProperty(value = "门店信息") private YxSystemStoreQueryVo systemStore; + @ApiModelProperty(value = "用户ID") private Integer uid = 0; + @ApiModelProperty(value = "模版名称") private String tempName; } diff --git a/yshop-mall/src/main/java/co/yixiang/modules/product/vo/ReplyCountVo.java b/yshop-mall/src/main/java/co/yixiang/modules/product/vo/ReplyCountVo.java index 92abc3b5..b07b4f9e 100644 --- a/yshop-mall/src/main/java/co/yixiang/modules/product/vo/ReplyCountVo.java +++ b/yshop-mall/src/main/java/co/yixiang/modules/product/vo/ReplyCountVo.java @@ -1,5 +1,6 @@ package co.yixiang.modules.product.vo; +import io.swagger.annotations.ApiModelProperty; import lombok.AllArgsConstructor; import lombok.Builder; import lombok.Getter; @@ -19,11 +20,23 @@ import java.io.Serializable; @NoArgsConstructor @Builder public class ReplyCountVo implements Serializable { + + @ApiModelProperty(value = "总的评论数") private Integer sumCount; + + @ApiModelProperty(value = "好评数") private Integer goodCount; + + @ApiModelProperty(value = "中评数") private Integer inCount; + + @ApiModelProperty(value = "差评数") private Integer poorCount; + + @ApiModelProperty(value = "好评率") private String replyChance; + + @ApiModelProperty(value = "好评星星数") private String replySstar; } diff --git a/yshop-mall/src/main/java/co/yixiang/modules/product/vo/YxStoreProductQueryVo.java b/yshop-mall/src/main/java/co/yixiang/modules/product/vo/YxStoreProductQueryVo.java index 8bbfe09b..58c0397c 100644 --- a/yshop-mall/src/main/java/co/yixiang/modules/product/vo/YxStoreProductQueryVo.java +++ b/yshop-mall/src/main/java/co/yixiang/modules/product/vo/YxStoreProductQueryVo.java @@ -44,11 +44,13 @@ public class YxStoreProductQueryVo implements Serializable { return image; } + @ApiModelProperty(value = "是否收藏") private Boolean userCollect = false; + @ApiModelProperty(value = "是否喜欢") private Boolean userLike = false; - @ApiModelProperty(value = "轮播图") + @ApiModelProperty(value = "轮播图，多个用,分割") private String sliderImage; private List sliderImageArr; @@ -123,17 +125,22 @@ public class YxStoreProductQueryVo implements Serializable { @ApiModelProperty(value = "浏览量") private Integer browse; + @ApiModelProperty(value = "状态（0：未上架，1：上架）") private Integer isShow; + @ApiModelProperty(value = "获得积分") private BigDecimal giveIntegral; + @ApiModelProperty(value = "运费模板ID") private Integer tempId; /** 是否单独分佣 */ + @ApiModelProperty(value = "是否单独分佣") private Integer isSub; /** 规格 0单 1多 */ + @ApiModelProperty(value = "规格 0单 1多 ") private Integer specType; -} \ No newline at end of file +} diff --git a/yshop-mall/src/main/java/co/yixiang/modules/product/vo/YxStoreProductRelationQueryVo.java b/yshop-mall/src/main/java/co/yixiang/modules/product/vo/YxStoreProductRelationQueryVo.java index 8b85351b..58ec6136 100644 --- a/yshop-mall/src/main/java/co/yixiang/modules/product/vo/YxStoreProductRelationQueryVo.java +++ b/yshop-mall/src/main/java/co/yixiang/modules/product/vo/YxStoreProductRelationQueryVo.java @@ -37,18 +37,25 @@ public class YxStoreProductRelationQueryVo implements Serializable { @ApiModelProperty(value = "添加时间") private Date createTime; + @ApiModelProperty(value = "产品图片") private String image; + @ApiModelProperty(value = "是否显示") private Integer isShow; + @ApiModelProperty(value = "原价") private Double otPrice; + @ApiModelProperty(value = "父ID") private Integer pid; + @ApiModelProperty(value = "产品价格") private Double price; + @ApiModelProperty(value = "产品销量") private Integer sales; + @ApiModelProperty(value = "商品名称") private String storeName; -} \ No newline at end of file +} diff --git a/yshop-mall/src/main/java/co/yixiang/modules/product/vo/YxStoreProductReplyQueryVo.java b/yshop-mall/src/main/java/co/yixiang/modules/product/vo/YxStoreProductReplyQueryVo.java index 2d2e944f..8036ea9b 100644 --- a/yshop-mall/src/main/java/co/yixiang/modules/product/vo/YxStoreProductReplyQueryVo.java +++ b/yshop-mall/src/main/java/co/yixiang/modules/product/vo/YxStoreProductReplyQueryVo.java @@ -67,19 +67,20 @@ public class YxStoreProductReplyQueryVo implements Serializable { @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss",timezone="GMT+8") private Date createTime; + @ApiModelProperty(value = "评价星星数") private String star; + @ApiModelProperty(value = "用户昵称") private String nickname; + @ApiModelProperty(value = "用户头像") private String avatar; + @ApiModelProperty(value = "商品sku") private String sku; - - @JsonIgnore private String cartInfo; - -} \ No newline at end of file +} diff --git a/yshop-mall/src/main/java/co/yixiang/modules/product/vo/YxSystemStoreQueryVo.java b/yshop-mall/src/main/java/co/yixiang/modules/product/vo/YxSystemStoreQueryVo.java index 23a578cf..75230c2c 100644 --- a/yshop-mall/src/main/java/co/yixiang/modules/product/vo/YxSystemStoreQueryVo.java +++ b/yshop-mall/src/main/java/co/yixiang/modules/product/vo/YxSystemStoreQueryVo.java @@ -19,6 +19,7 @@ import java.io.Serializable; public class YxSystemStoreQueryVo implements Serializable { private static final long serialVersionUID = 1L; + @ApiModelProperty(value = "门店ID") private Integer id; @ApiModelProperty(value = "门店名称") @@ -57,7 +58,7 @@ public class YxSystemStoreQueryVo implements Serializable { @ApiModelProperty(value = "每日营业开关时间") private String dayTime; - + @ApiModelProperty(value = "距离") private String distance; } diff --git a/yshop-mall/src/main/java/co/yixiang/modules/user/param/AddressDetailParam.java b/yshop-mall/src/main/java/co/yixiang/modules/user/param/AddressDetailParam.java index c3c5ca05..d3e8c4b0 100644 --- a/yshop-mall/src/main/java/co/yixiang/modules/user/param/AddressDetailParam.java +++ b/yshop-mall/src/main/java/co/yixiang/modules/user/param/AddressDetailParam.java @@ -1,6 +1,7 @@ package co.yixiang.modules.user.param; import com.fasterxml.jackson.annotation.JsonProperty; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.io.Serializable; @@ -12,9 +13,17 @@ import java.io.Serializable; **/ @Data public class AddressDetailParam implements Serializable { + @JsonProperty(value = "city_id") + @ApiModelProperty(value = "城市ID") private Integer cityId; + + @ApiModelProperty(value = "城市") private String city; + + @ApiModelProperty(value = "地区") private String district; + + @ApiModelProperty(value = "省份") private String province; } diff --git a/yshop-mall/src/main/java/co/yixiang/modules/user/param/AddressParam.java b/yshop-mall/src/main/java/co/yixiang/modules/user/param/AddressParam.java index ecc459ac..f9df5ce5 100644 --- a/yshop-mall/src/main/java/co/yixiang/modules/user/param/AddressParam.java +++ b/yshop-mall/src/main/java/co/yixiang/modules/user/param/AddressParam.java @@ -1,6 +1,7 @@ package co.yixiang.modules.user.param; import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import javax.validation.constraints.NotBlank; @@ -15,17 +16,31 @@ import java.io.Serializable; @Data @JsonIgnoreProperties(ignoreUnknown = true) public class AddressParam implements Serializable { + + @ApiModelProperty(value = "地址ID") private String id; @NotBlank @Size(min = 1, max = 30,message = "长度超过了限制") + @ApiModelProperty(value = "收货地址真实名字") private String real_name; + + @ApiModelProperty(value = "收货地址邮编") private String post_code; + + @ApiModelProperty(value = "是否默认收货地址 true是 false否") private String is_default; + private String wx_export; + @NotBlank @Size(min = 1, max = 60,message = "长度超过了限制") + @ApiModelProperty(value = "收货详细地址") private String detail; + @NotBlank + @ApiModelProperty(value = "收货手机号码") private String phone; + + @ApiModelProperty(value = "收货地址详情") private AddressDetailParam address; } diff --git a/yshop-mall/src/main/java/co/yixiang/modules/user/vo/YxUserQueryVo.java b/yshop-mall/src/main/java/co/yixiang/modules/user/vo/YxUserQueryVo.java index 77456c8e..79db8e83 100644 --- a/yshop-mall/src/main/java/co/yixiang/modules/user/vo/YxUserQueryVo.java +++ b/yshop-mall/src/main/java/co/yixiang/modules/user/vo/YxUserQueryVo.java @@ -32,18 +32,25 @@ public class YxUserQueryVo implements Serializable { @ApiModelProperty(value = "用户账号") private String account; + @ApiModelProperty(value = "优惠券数量") private Integer couponCount = 0; + @ApiModelProperty(value = "订单详情数据") private UserOrderCountVo orderStatusNum; + private Integer statu; + @ApiModelProperty(value = "总的签到天数") private Integer sumSignDay; + @ApiModelProperty(value = "当天是否签到") private Boolean isDaySign; + @ApiModelProperty(value = "昨天是否签到") private Boolean isYesterDaySign; + @ApiModelProperty(value = "核销权限") private Boolean checkStatus; @@ -119,12 +126,16 @@ public class YxUserQueryVo implements Serializable { @ApiModelProperty(value = "用户登陆类型，h5,wechat,routine") private String loginType; + @ApiModelProperty(value = "是否会员") private Boolean vip; + @ApiModelProperty(value = "会员ID") private Integer vipId; + @ApiModelProperty(value = "会员图标") private String vipIcon; + @ApiModelProperty(value = "会员名称") private String vipName; } diff --git a/yshop-mall/src/main/java/co/yixiang/modules/wechat/vo/YxArticleQueryVo.java b/yshop-mall/src/main/java/co/yixiang/modules/wechat/vo/YxArticleQueryVo.java index 89fd8e82..329b7271 100644 --- a/yshop-mall/src/main/java/co/yixiang/modules/wechat/vo/YxArticleQueryVo.java +++ b/yshop-mall/src/main/java/co/yixiang/modules/wechat/vo/YxArticleQueryVo.java @@ -59,6 +59,7 @@ public class YxArticleQueryVo implements Serializable { @JsonProperty(value = "addTime") private String createTime; + @ApiModelProperty(value = "文章内容") private String content; -} \ No newline at end of file +} diff --git a/yshop-tools/src/main/java/co/yixiang/tools/express/dao/ExpressInfo.java b/yshop-tools/src/main/java/co/yixiang/tools/express/dao/ExpressInfo.java index 4daa570f..7eeeca1e 100644 --- a/yshop-tools/src/main/java/co/yixiang/tools/express/dao/ExpressInfo.java +++ b/yshop-tools/src/main/java/co/yixiang/tools/express/dao/ExpressInfo.java @@ -9,6 +9,7 @@ package co.yixiang.tools.express.dao; import com.fasterxml.jackson.annotation.JsonProperty; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.util.List; @@ -23,23 +24,41 @@ import java.util.List; public class ExpressInfo { @JsonProperty("LogisticCode") + @ApiModelProperty(value = "物流运单号") private String LogisticCode; + @JsonProperty("ShipperCode") + @ApiModelProperty(value = "快递公司编码") private String ShipperCode; + + @JsonProperty("Traces") + @ApiModelProperty(value = "物流轨迹") private List Traces; + + @JsonProperty("State") + @ApiModelProperty(value = "物流状态：2-在途中,3-签收,4-问题件") private String State; + @JsonProperty("EBusinessID") + @ApiModelProperty(value = "用户ID") private String EBusinessID; + + @JsonProperty("Success") + @ApiModelProperty(value = "成功与否") private boolean Success; + + @JsonProperty("Reason") + @ApiModelProperty(value = "失败原因") private String Reason; private String ShipperName; @JsonProperty("OrderCode") + @ApiModelProperty(value = "订单编号") private String OrderCode; diff --git a/yshop-tools/src/main/java/co/yixiang/tools/express/dao/Traces.java b/yshop-tools/src/main/java/co/yixiang/tools/express/dao/Traces.java index c0339de7..a43db9b2 100644 --- a/yshop-tools/src/main/java/co/yixiang/tools/express/dao/Traces.java +++ b/yshop-tools/src/main/java/co/yixiang/tools/express/dao/Traces.java @@ -9,6 +9,7 @@ package co.yixiang.tools.express.dao; import com.fasterxml.jackson.annotation.JsonProperty; +import io.swagger.annotations.ApiModelProperty; /** * Auto-generated: 2018-07-19 22:27:22 @@ -19,8 +20,11 @@ import com.fasterxml.jackson.annotation.JsonProperty; public class Traces { @JsonProperty("AcceptStation") + @ApiModelProperty(value = "描述") private String AcceptStation; + @JsonProperty("AcceptTime") + @ApiModelProperty(value = "时间") private String AcceptTime; public String getAcceptStation() {