优化api文档

src/main/java/com/sqx/modules/activity/controller/ActivityShopController.java

@@ -8,6 +8,7 @@ import com.sqx.modules.activity.dto.QuitActivityDTO;
 import com.sqx.modules.activity.service.ActivityShopService;
 import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiParam;
 import lombok.RequiredArgsConstructor;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
@@ -34,7 +35,7 @@ public class ActivityShopController{
 
     @ApiOperation("活动参与的商家列表")
     @GetMapping("activity-shop-page/{activityId}")
-    public Result getActivityShopPage(@PathVariable Long activityId, PageQuery queryDTO) {
+    public Result getActivityShopPage(@PathVariable @ApiParam("活动id") Long activityId, PageQuery queryDTO) {
         PageUtils page = activityShopService.getShopByActivityId(activityId, queryDTO);
         return Result.success().put("data", page);
     }
@@ -55,7 +56,7 @@ public class ActivityShopController{
 
     @ApiOperation("商家退出活动(根据参与id退出)")
     @PutMapping("quit-by-id/{activityShopId}")
-    public Result quitByActivityShopId(@PathVariable Long activityShopId) {
+    public Result quitByActivityShopId(@PathVariable @ApiParam("活动店铺id") Long activityShopId) {
         activityShopService.quitByActivityShopId(activityShopId);
         return Result.success();
     }

src/main/java/com/sqx/modules/activity/controller/app/AppActivityController.java

@@ -5,6 +5,7 @@ import com.sqx.modules.activity.service.ActivityService;
 import com.sqx.modules.activity.vo.OrderSuitActivityVO;
 import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiParam;
 import lombok.RequiredArgsConstructor;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
@@ -28,7 +29,7 @@ public class AppActivityController {
 
     @GetMapping("suit-activity/{orderId}")
     @ApiOperation(value = "获取适用的活动列表")
-    public Result getOrderSuitActivity(@PathVariable Long orderId) {
+    public Result getOrderSuitActivity(@PathVariable @ApiParam("订单id") Long orderId) {
         List<OrderSuitActivityVO> suitActivityVOList = activityService.getOrderSuitActivity(orderId);
         return Result.success().put("data", suitActivityVOList);
     }

src/main/java/com/sqx/modules/activity/controller/app/AppActivityGoodsController.java

@@ -5,6 +5,7 @@ import com.sqx.modules.activity.service.ActivityGoodsService;
 import com.sqx.modules.activity.vo.GoodsActivityVO;
 import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiParam;
 import lombok.RequiredArgsConstructor;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
@@ -29,7 +30,7 @@ public class AppActivityGoodsController {
 
    @GetMapping("{goodsId}")
    @ApiOperation("查看商品参与的活动列表")
-   public Result getActivityListByGoodsId(@PathVariable Long goodsId) {
+   public Result getActivityListByGoodsId(@PathVariable @ApiParam("商品id") Long goodsId) {
        List<GoodsActivityVO> goodsActivityVOS = activityGoodsService.getActivityListByGoodsId(Arrays.asList(goodsId));
        return Result.success().put("data", goodsActivityVOS);
    }