cxc/yshopb2c
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

task--完善swagger文档注释

Browse Source
This commit is contained in:
taochengbo
2020-08-23 00:44:02 +08:00
parent 698d678eb5
commit 42a06b543d
80 changed files with 652 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
yshop-app/src/main/java/co/yixiang/common/web/param/IdParam.java
View File

@ -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;
}

4
yshop-app/src/main/java/co/yixiang/modules/activity/param/BargainShareParam.java
View File

@ -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;
}

5
yshop-app/src/main/java/co/yixiang/modules/activity/param/PinkCancelParam.java
View File

@ -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;
}

2
yshop-app/src/main/java/co/yixiang/modules/activity/param/PinkShareParam.java
View File

@ -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;
}

4
yshop-app/src/main/java/co/yixiang/modules/activity/param/YxStoreBargainUserHelpQueryParam.java
View File

@ -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;
}

3
yshop-app/src/main/java/co/yixiang/modules/activity/param/YxStoreBargainUserQueryParam.java
View File

@ -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;
}

10
yshop-app/src/main/java/co/yixiang/modules/activity/rest/StoreBargainController.java
View File

@ -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<Object> 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<List<YxStoreBargainUserQueryVo>> bargainUserList(
@RequestParam(value = "page",defaultValue = "1") int page,

6
yshop-app/src/main/java/co/yixiang/modules/activity/rest/StoreCombinationController.java
View File

@ -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<List<YxStoreCombinationQueryVo>> getList(@RequestParam(value = "page",defaultValue = "1") int page,
@RequestParam(value = "limit",defaultValue = "10") int limit){

5
yshop-app/src/main/java/co/yixiang/modules/auth/param/HLoginParam.java
View File

@ -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;

6
yshop-app/src/main/java/co/yixiang/modules/auth/param/LoginParam.java
View File

@ -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;
}

7
yshop-app/src/main/java/co/yixiang/modules/auth/param/RegParam.java
View File

@ -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;
}

4
yshop-app/src/main/java/co/yixiang/modules/auth/param/VerityParam.java
View File

@ -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;
}

6
yshop-app/src/main/java/co/yixiang/modules/auth/rest/AuthController.java
View File

@ -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<Map<String, Object>> authLogin(@RequestParam(value = "code") String code,
@RequestParam(value = "spread") String spread,

3
yshop-app/src/main/java/co/yixiang/modules/cart/param/CartIdsParm.java
View File

@ -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<String> ids;
}

5
yshop-app/src/main/java/co/yixiang/modules/cart/param/CartNumParam.java
View File

@ -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;
}

14
yshop-app/src/main/java/co/yixiang/modules/cart/param/CartParam.java
View File

@ -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;
}

2
yshop-app/src/main/java/co/yixiang/modules/coupon/param/YxStoreCouponQueryParam.java
View File

@ -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;
}

11
yshop-app/src/main/java/co/yixiang/modules/coupon/rest/CouponController.java
View File

@ -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<List<YxStoreCouponIssueQueryVo>> 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<List<StoreCouponUserVo>> orderCoupon(@PathVariable String cartIds){
Long uid = LocalUser.getUser().getUid();

5
yshop-app/src/main/java/co/yixiang/modules/manage/param/OrderPriceParam.java
View File

@ -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;
}

5
yshop-app/src/main/java/co/yixiang/modules/manage/param/OrderRemarkParam.java
View File

@ -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;
}

3
yshop-app/src/main/java/co/yixiang/modules/manage/param/ShoperQueryParam.java
View File

@ -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;

6
yshop-app/src/main/java/co/yixiang/modules/manage/rest/ShoperController.java
View File

@ -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<List<OrderDataVo>> data(@RequestParam(value = "page",defaultValue = "1") int page,
@RequestParam(value = "limit",defaultValue = "10") int limit){

7
yshop-app/src/main/java/co/yixiang/modules/order/dto/OrderExtendDto.java
View File

@ -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<String,String> jsConfig;
}

16
yshop-app/src/main/java/co/yixiang/modules/order/param/ComputeOrderParam.java
View File

@ -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;
}

3
yshop-app/src/main/java/co/yixiang/modules/order/param/ConfirmOrderParam.java
View File

@ -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;
}

2
yshop-app/src/main/java/co/yixiang/modules/order/param/DoOrderParam.java
View File

@ -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;
}

8
yshop-app/src/main/java/co/yixiang/modules/order/param/ExpressParam.java
View File

@ -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;
}

3
yshop-app/src/main/java/co/yixiang/modules/order/param/HandleOrderParam.java
View File

@ -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;
}

9
yshop-app/src/main/java/co/yixiang/modules/order/param/OrderDeliveryParam.java
View File

@ -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;
}

7
yshop-app/src/main/java/co/yixiang/modules/order/param/OrderRefundParam.java
View File

@ -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;
}

4
yshop-app/src/main/java/co/yixiang/modules/order/param/OrderVerifyParam.java
View File

@ -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;
}

7
yshop-app/src/main/java/co/yixiang/modules/order/param/PayParam.java
View File

@ -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;
}

3
yshop-app/src/main/java/co/yixiang/modules/order/param/ProductOrderParam.java
View File

@ -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;
}

11
yshop-app/src/main/java/co/yixiang/modules/order/param/ProductReplyParam.java
View File

@ -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;
}

13
yshop-app/src/main/java/co/yixiang/modules/order/param/RefundParam.java
View File

@ -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;
}

14
yshop-app/src/main/java/co/yixiang/modules/order/rest/StoreOrderController.java
View File

@ -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<Map<String,Object>> 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<List<YxStoreOrderQueryVo>> 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<YxStoreOrderQueryVo> detail(@PathVariable String key){
Long uid = LocalUser.getUser().getUid();

5
yshop-app/src/main/java/co/yixiang/modules/product/param/YxStoreProductRelationQueryParam.java
View File

@ -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;
}

23
yshop-app/src/main/java/co/yixiang/modules/product/rest/StoreProductController.java
View File

@ -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<Map<String,Object>> moreGoodsList(@PathVariable Integer type){
Map<String,Object> 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<String> 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<ProductVo> 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<List<YxStoreProductReplyQueryVo>> 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<ReplyCountVo> replyCount(@PathVariable Integer id){
return ApiResult.ok(replyService.getReplyCount(id));

3
yshop-app/src/main/java/co/yixiang/modules/shop/param/YxSystemStoreQueryParam.java
View File

@ -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;
}

11
yshop-app/src/main/java/co/yixiang/modules/user/param/PromParam.java
View File

@ -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;
}

6
yshop-app/src/main/java/co/yixiang/modules/user/param/RechargeParam.java
View File

@ -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;
}

4
yshop-app/src/main/java/co/yixiang/modules/user/param/UserEditParam.java
View File

@ -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;

14
yshop-app/src/main/java/co/yixiang/modules/user/rest/UserBillController.java
View File

@ -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<List<YxUserBillQueryVo>> 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<List<Map<String,Object>>> 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<Object> spreadCommission(@RequestParam(value = "page",defaultValue = "1") int page,
@RequestParam(value = "limit",defaultValue = "10") int limit,

14
yshop-app/src/main/java/co/yixiang/modules/user/rest/UserController.java
View File

@ -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<List<YxStoreProductRelationQueryVo>> 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<List<SignVo>> 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<Object> signMonthList(@RequestParam(value = "page",defaultValue = "1") int page,
@RequestParam(value = "limit",defaultValue = "10") int limit){

4
yshop-app/src/main/java/co/yixiang/modules/wechat/rest/param/BindPhoneParam.java
View File

@ -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;
}

5
yshop-app/src/main/java/co/yixiang/modules/wechat/rest/param/WxPhoneParam.java
View File

@ -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;
}