swagger注释补齐

mp-admin/src/main/java/com/qs/mp/web/controller/api/admin/SaleSiteMgrController.java

@@ -31,6 +31,8 @@ import com.qs.mp.user.service.IUserTicketOrderService;
 import com.qs.mp.web.controller.common.BaseApiController;
 import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
+import io.swagger.annotations.ApiResponse;
+import io.swagger.annotations.ApiResponses;
 import ma.glasnost.orika.MapperFacade;
 
 import java.math.BigDecimal;
@@ -54,10 +56,9 @@ import org.springframework.web.bind.annotation.RestController;
  * @create 2022-02-28 16:17:48
  * @describe 经销商管理前端控制器
  */
-@Api("经销商管理API")
+@Api(tags = "经销商管理API")
 @RestController
 @RequestMapping("/api/v1/mp/admin/salesite/*")
-@Component
 public class SaleSiteMgrController extends BaseApiController {
 
 	@Autowired
@@ -89,6 +90,10 @@ public class SaleSiteMgrController extends BaseApiController {
 	 */
 	@PostMapping("/list")
 	@PreAuthorize("@ss.hasPermi('business:salesite:list')")
+	@ApiOperation("获取经销商列表信息，支持翻页")
+	@ApiResponses(
+			@ApiResponse(code = 200, message = "经销商列表返回信息",response = ChannelVO.class)
+	)
 	public TableDataInfo listSite(@RequestBody Channel channel) {
 		List<ChannelVO> list = new ArrayList<ChannelVO>();
 		startPage();
@@ -161,6 +166,10 @@ public class SaleSiteMgrController extends BaseApiController {
 	 */
 	@PostMapping("/listAll")
 	// @PreAuthorize("@ss.hasPermi('business:salesite:list')")
+	@ApiOperation("查询所有渠道列表")
+	@ApiResponses(
+			@ApiResponse(code = 200, message = "经销商列表返回信息",response = Channel.class)
+	)
 	public AjaxResult listAllSite() {
 		List<Channel> list = new ArrayList<Channel>();
 		LambdaQueryWrapper<Channel> queryWrapper = new LambdaQueryWrapper<Channel>();

mp-service/src/main/java/com/qs/mp/channel/domain/vo/ChannelVO.java

@@ -1,6 +1,8 @@
 package com.qs.mp.channel.domain.vo;
 
 import com.qs.mp.channel.domain.Channel;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -8,21 +10,32 @@ import lombok.Data;
  * @Date 2022/3/1
  */
 @Data
+@ApiModel("渠道经销商相关出参类")
 public class ChannelVO extends Channel {
+  @ApiModelProperty("经销网点数")
   long siteCnt;   // 经销网点数
+  @ApiModelProperty("用户数")
   long userCnt;   // 用户数
-  
+
+  @ApiModelProperty("上级渠道名称")
   String parentName; // 上级渠道名称
-  
+
+  @ApiModelProperty("订单数")
   long orderCnt;   // 订单数
+  @ApiModelProperty("子渠道数量")
   int childCnt;  // 子渠道数量
+  @ApiModelProperty("经营数据")
   ChannelOperDataVO operData;  // 经营数据
   // SysUser sysUser;  // 关联的用户账号信息
-  
+
+  @ApiModelProperty("所有上级渠道名称 eg: 一级渠道 > 上N级渠道 ** > 上级渠道")
   String parentsName; // 所有上级渠道名称 eg: 一级渠道 > 上N级渠道 ** > 上级渠道
-  
+
+  @ApiModelProperty("线下库存（盲票张数）")
   long offLineQtyCnt; // 线下库存（盲票张数）
+  @ApiModelProperty("线下销售（线下盲票销售张数）")
   long offLineSaleCnt; // 线下销售（线下盲票销售张数）
+  @ApiModelProperty("线上销售（显示盲票销售张数）")
   long onLineSaleCnt; // 线上销售（显示盲票销售张数）