促销活动接口Api

src/main/java/com/caimei365/commodity/controller/ProductPriceApi.java

@@ -5,6 +5,9 @@ import com.caimei365.commodity.model.vo.LadderPriceVo;
 import com.caimei365.commodity.model.vo.PriceVo;
 import com.caimei365.commodity.service.PriceService;
 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.apache.commons.lang.StringUtils;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -34,6 +37,11 @@ public class ProductPriceApi {
      * @param userId      用户Id
      * @param productId   商品Id
      */
+    @ApiOperation("获取商品详情价格")
+    @ApiImplicitParams({
+        @ApiImplicitParam(required = true, name = "userId", value = "用户Id"),
+        @ApiImplicitParam(required = true, name = "productId", value = "商品Id")
+    })
     @GetMapping("detail")
     public ResponseJson<PriceVo> getDetailPrice(Integer userId, Integer productId) {
         if (null == userId || null == productId) {
@@ -50,6 +58,11 @@ public class ProductPriceApi {
      * @param userId       用户Id
      * @param productIds   商品Id
      */
+    @ApiOperation("获取商品列表价格")
+    @ApiImplicitParams({
+        @ApiImplicitParam(required = true, name = "userId", value = "用户Id"),
+        @ApiImplicitParam(required = true, name = "productIds", value = "商品Ids,逗号拼接")
+    })
     @GetMapping("/list")
     public ResponseJson<List<PriceVo>> getProductPrice(Integer userId, String productIds) {
         if (null == userId || StringUtils.isEmpty(productIds)) {
@@ -65,6 +78,8 @@ public class ProductPriceApi {
      *
      * @param productId   商品Id
      */
+    @ApiOperation("获取阶梯价格")
+    @ApiImplicitParam(required = true, name = "productId", value = "商品Id")
     @GetMapping("/ladder")
     public ResponseJson<List<LadderPriceVo>> getLadderPrice(Integer productId) {
         if (null == productId) {

src/main/java/com/caimei365/commodity/controller/PromotionsApi.java

@@ -8,6 +8,9 @@ import com.caimei365.commodity.model.vo.PromotionsVo;
 import com.caimei365.commodity.service.PromotionsService;
 import com.github.pagehelper.PageInfo;
 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.web.bind.annotation.*;
 
@@ -32,8 +35,13 @@ public class PromotionsApi {
      *
      * @param source 来源
      */
+    @ApiOperation("专题活动列表数据")
+    @ApiImplicitParams({
+        @ApiImplicitParam(required = false, name = "source", value = "来源"),
+        @ApiImplicitParam(required = false, name = "pageNum", value = "页码"),
+        @ApiImplicitParam(required = false, name = "pageSize", value = "每页数量")
+    })
     @GetMapping("/list")
-    @ResponseBody
     public ResponseJson<PageInfo<ImageLinkVo>> getPromotionsList(Integer source,
                                                                  @RequestParam(value = "pageNum", defaultValue = "1") int pageNum,
                                                                  @RequestParam(value = "pageSize", defaultValue = "20") int pageSize) {
@@ -47,6 +55,8 @@ public class PromotionsApi {
      *
      * @param promotionsId 促销活动Id
      */
+    @ApiOperation("获取促销活动详情")
+    @ApiImplicitParam(required = true, name = "promotionsId", value = "促销活动Id")
     @GetMapping("/info")
     public ResponseJson<PromotionsVo> promotionDetails(Integer promotionsId) {
         if (null == promotionsId) {
@@ -63,6 +73,13 @@ public class PromotionsApi {
      * @param promotionsId 促销活动Id
      * @param identity     用户身份
      */
+    @ApiOperation("获取促销活动凑单商品")
+    @ApiImplicitParams({
+        @ApiImplicitParam(required = true, name = "promotionsId", value = "促销活动Id"),
+        @ApiImplicitParam(required = false, name = "identity", value = "用户身份: 0个人，1协销，2会员机构，3供应商，4普通机构"),
+        @ApiImplicitParam(required = false, name = "pageNum", value = "页码"),
+        @ApiImplicitParam(required = false, name = "pageSize", value = "每页数量")
+    })
     @GetMapping("/product")
     public ResponseJson<PageInfo<ProductListVo>> promotionProduct(Integer promotionsId,
                                                                @RequestParam(value = "identity", defaultValue = "0") Integer identity,
@@ -81,6 +98,8 @@ public class PromotionsApi {
      *
      * @param promotionsId 促销活动Id
      */
+    @ApiOperation("获取赠品")
+    @ApiImplicitParam(required = true, name = "promotionsId", value = "促销活动Id")
     @GetMapping("/gifts")
     public ResponseJson<List<CartItemVo>> getPromotionGifts(Integer promotionsId) {
         if (null == promotionsId) {