【ID1010972】多人拼单

购物车聚合拼单订单相关接口swagger注解补充

shopping-cart-application-service/src/main/java/cn/freemud/controller/ShoppingCartCollageController.java

@@ -19,6 +19,8 @@ import com.freemud.application.sdk.api.base.SDKCommonBaseContextWare;
 import com.freemud.application.sdk.api.log.ApiAnnotation;
 import com.freemud.application.sdk.api.log.LogParams;
 import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiOperation;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.http.MediaType;
 import org.springframework.validation.annotation.Validated;
@@ -30,19 +32,25 @@ import org.springframework.web.bind.annotation.*;
 @Slf4j
 public class ShoppingCartCollageController {
 
-    @ApiAnnotation(logMessage = "查询拼单订单")
+    @ApiOperation(value = "查询拼单订单", notes = "根据商户ID、门店ID、拼单邀请人用户ID或者当前登录用户sessionId查询拼单订单信息")
+    @ApiImplicitParam(value = "请求", required = true, dataType = "CollageOrderRequestVo", name = "CollageOrderRequestVo")
+    @ApiAnnotation(logMessage = "getOrder")
     @PostMapping(value = "/getOrder")
     public BaseResponse queryCollageOrder(@Validated @LogParams @RequestBody CollageOrderRequestVo request) {
         return SDKCommonBaseContextWare.getBean(ShoppingCartCollageServiceImpl.class).queryCollageOrder(request);
     }
 
-    @ApiAnnotation(logMessage = "创建拼单订单")
+    @ApiOperation(value = "创建拼单订单", notes = "根据商户ID、门店ID、当前登录用户sessionId创建拼单订单信息")
+    @ApiImplicitParam(value = "请求", required = true, dataType = "CollageOrderRequestVo", name = "CollageOrderRequestVo")
+    @ApiAnnotation(logMessage = "createOrder")
     @PostMapping(value = "/createOrder")
     public BaseResponse createOrder(@Validated @LogParams @RequestBody CollageOrderRequestVo request) {
         return SDKCommonBaseContextWare.getBean(ShoppingCartCollageServiceImpl.class).createCollageOrder(request);
     }
 
-    @ApiAnnotation(logMessage = "取消拼单订单")
+    @ApiOperation(value = "取消拼单订单", notes = "根据商户ID、门店ID、当前登录用户sessionId取消拼单订单，并删除相关拼单信息")
+    @ApiImplicitParam(value = "请求", required = true, dataType = "CollageOrderRequestVo", name = "CollageOrderRequestVo")
+    @ApiAnnotation(logMessage = "cancelOrder")
     @PostMapping(value = "/cancelOrder")
     public BaseResponse cancelCollageOrder(@Validated @LogParams @RequestBody CollageOrderRequestVo request) {
         return SDKCommonBaseContextWare.getBean(ShoppingCartCollageServiceImpl.class).cancelCollageOrder(request);

shopping-cart-application-service/src/main/java/cn/freemud/entities/vo/CollageOrderRequestVo.java

@@ -12,21 +12,26 @@
  */
 package cn.freemud.entities.vo;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Builder;
 import lombok.Data;
 import org.hibernate.validator.constraints.NotEmpty;
 
 @Builder
 @Data
-public class CollageOrderRequestVo extends BaseRequestVo {
+public class CollageOrderRequestVo {
+    @ApiModelProperty(value = "当前登录人sessionId", required = true)
     @NotEmpty(message = "sessionId不能为空")
     private String sessionId;
 
+    @ApiModelProperty(value = "拼单创建人用户ID")
     private String createCollageUserId;
 
+    @ApiModelProperty(value = "商户ID", required = true)
     @NotEmpty(message = "商户ID 不能为空")
     private String partnerId;
 
+    @ApiModelProperty(value = "门店ID", required = true)
     @NotEmpty(message = "门店ID 不能为空")
     private String shopId;
 }