webchat swagger接口文档支持

src/main/java/com/webchat/common/enums/ArticleStatusEnum.java

@@ -12,7 +12,7 @@ public enum ArticleStatusEnum {
 
     WAIT_PUSH(1, "待推送"),
 
-    PUSHED(2, "待推送");
+    PUSHED(2, "已推送");
 
     private Integer status;
     private String statusName;

src/main/java/com/webchat/config/configuration/SwaggerConfig.java

@@ -36,7 +36,7 @@ public class SwaggerConfig {
     private ApiInfo apiInfo() {
         return new ApiInfoBuilder()
                 .title("WebChat API Document")
-                .description("在线聊天室借口文档")
+                .description("WebChat 接口文档")
                 .version("1.0.0")
                 .build();
     }

src/main/java/com/webchat/controller/FileUploadController.java

@@ -5,9 +5,11 @@ import com.webchat.common.bean.APIResponseBeanUtil;
 import com.webchat.common.enums.FileTypeEnum;
 import com.webchat.common.exception.BusinessException;
 import com.webchat.config.annotation.ValidateLogin;
-import com.webchat.domain.vo.response.EditorUpdateResultResponse;
-import com.webchat.domain.vo.response.EditorUpdateResultResponseVO;
+import com.webchat.domain.vo.response.EditorUploadResultResponse;
+import com.webchat.domain.vo.response.EditorUploadResultResponseVO;
 import com.webchat.domain.vo.response.UploadResultVO;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.util.Assert;
 import org.springframework.web.bind.annotation.PostMapping;
@@ -24,6 +26,8 @@ import java.util.Arrays;
 import java.util.List;
 import java.util.UUID;
 
+
+@Api(tags = "【文件上传】文件上传本地服务")
 @Slf4j
 @RestController
 @RequestMapping("/api/file")
@@ -49,6 +53,7 @@ public class FileUploadController {
      * @param file
      * @return
      */
+    @ApiOperation("文件上传接口")
     @ValidateLogin
     @PostMapping("/moment/upload")
     public APIResponseBean<UploadResultVO> handleFileUpload(@RequestParam("file") MultipartFile file) {
@@ -102,6 +107,7 @@ public class FileUploadController {
      * @param file
      * @return
      */
+    @ApiOperation("文件上传接口")
     @ValidateLogin
     @PostMapping("/chat/upload")
     public APIResponseBean<UploadResultVO> chatUpload(@RequestParam("file") MultipartFile file) {
@@ -156,12 +162,13 @@ public class FileUploadController {
      * @param file
      * @return
      */
+    @ApiOperation("上传文件到本地")
     @PostMapping("/updateForEditor")
-    public EditorUpdateResultResponse updateForEditor(@RequestParam("file") MultipartFile file) {
+    public EditorUploadResultResponse updateForEditor(@RequestParam("file") MultipartFile file) {
         Assert.notNull(file != null, "未获取到文件！");
 
         Integer errno = 0;
-        EditorUpdateResultResponseVO data = new EditorUpdateResultResponseVO();
+        EditorUploadResultResponseVO data = new EditorUploadResultResponseVO();
 
         APIResponseBean<UploadResultVO> responseBean = this.handleFileUpload(file);
         if (APIResponseBeanUtil.isOk(responseBean)) {
@@ -172,6 +179,6 @@ public class FileUploadController {
             // 文件上传失败
             errno = -1;
         }
-        return EditorUpdateResultResponse.of(errno, data);
+        return EditorUploadResultResponse.of(errno, data);
     }
 }

src/main/java/com/webchat/controller/PageController.java

@@ -1,5 +1,6 @@
 package com.webchat.controller;
 
+import io.swagger.annotations.Api;
 import org.springframework.stereotype.Controller;
 import org.springframework.ui.Model;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -8,6 +9,7 @@ import org.springframework.web.bind.annotation.PathVariable;
 /***
  * 页面转发控制器
  */
+@Api(tags = "【路由】页面路由配置")
 @Controller
 public class PageController {
 

src/main/java/com/webchat/controller/SlideVerificationController.java

@@ -7,6 +7,7 @@ import com.webchat.config.annotation.ValidatePermission;
 import com.webchat.domain.vo.request.SlideVerificationVO;
 import com.webchat.service.SlideVerificationService;
 import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
@@ -22,7 +23,7 @@ import org.springframework.web.bind.annotation.RestController;
  * @Date 2024/9/18 23:46
  * @description
  */
-@Api(tags = "滑块验证码")
+@Api(tags = "【登录】滑块验证码")
 @RestController
 @RequestMapping("/api/slide/verification")
 public class SlideVerificationController {
@@ -30,7 +31,7 @@ public class SlideVerificationController {
     @Autowired
     private SlideVerificationService slideVerificationService;
 
-
+    @ApiOperation("配置滑块验证")
     @ValidatePermission
     @PostMapping("/save")
     public APIResponseBean<Long> save(@RequestBody SlideVerificationVO slideVerificationVO) {
@@ -38,6 +39,7 @@ public class SlideVerificationController {
         return APIResponseBeanUtil.success(id);
     }
 
+    @ApiOperation("修改滑块验证配置状态")
     @ValidatePermission
     @PostMapping("/status/{id}/{status}")
     public APIResponseBean<Long> updateStatus(@PathVariable Long id, @PathVariable Integer status) {
@@ -45,18 +47,21 @@ public class SlideVerificationController {
         return APIResponseBeanUtil.success();
     }
 
+    @ApiOperation("随机加载滑块配置")
     @GetMapping("/get")
     public APIResponseBean<SlideVerificationVO> get() {
         SlideVerificationVO slideVerification = slideVerificationService.get();
         return APIResponseBeanUtil.success(slideVerification);
     }
 
+    @ApiOperation("滑块验证")
     @PostMapping("/valid/{accessToken}")
     public APIResponseBean<Boolean> validate(@PathVariable String accessToken) {
         boolean validateResult = slideVerificationService.validate(accessToken);
         return APIResponseBeanUtil.success(validateResult);
     }
 
+    @ApiOperation("滑块配置列表查询")
     @ValidatePermission
     @GetMapping("/page")
     public APIPageResponseBean<SlideVerificationVO> page(@RequestParam(value = "status", required = false) Integer status,

src/main/java/com/webchat/controller/admin/AdminChatMessController.java

@@ -10,6 +10,10 @@ import com.webchat.domain.vo.request.mess.ChatMessageRequestVO;
 import com.webchat.domain.vo.response.mess.ChatMessageResponseVO;
 import com.webchat.domain.vo.response.mess.UserMessListResponseVO;
 import com.webchat.service.ChatMessService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiImplicitParams;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.*;
 
@@ -21,12 +25,19 @@ import java.util.List;
  * @Date 2022/12/10 22:29
  * @description
  */
+@Api(tags = "【管理后台】对话消息管理")
 @RestController
 @RequestMapping("/api/chat/mess")
 public class AdminChatMessController {
     @Autowired
     private ChatMessService chatMessService;
 
+    @ApiOperation("对话消息列表查询接口")
+    @ApiImplicitParams({
+            @ApiImplicitParam(name = "mess", value = "消息内容", dataType = "String"),
+            @ApiImplicitParam(name = "pageNo", value = "页码，默认1", dataType = "Integer"),
+            @ApiImplicitParam(name = "pageSize", value = "页条数，默认8", dataType = "Integer")
+    })
     @ValidatePermission
     @GetMapping("/page")
     public APIPageResponseBean<List<ChatMessageResponseVO>> pageMessage(

src/main/java/com/webchat/controller/admin/AdminUserController.java

@@ -12,6 +12,10 @@ import com.webchat.domain.vo.response.UserBaseResponseInfoVO;
 import com.webchat.domain.vo.response.UserSafeResponseInfoVO;
 import com.webchat.service.UserService;
 import com.webchat.service.ValidCodeService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiImplicitParams;
+import io.swagger.annotations.ApiOperation;
 import org.apache.commons.lang3.StringUtils;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.util.Assert;
@@ -24,6 +28,7 @@ import java.util.List;
  * @Date: 11.3.22 1:12 上午
  * 用户服务API
  */
+@Api(tags = "【管理后台】用户管理")
 @RestController
 @RequestMapping("/api/user")
 public class AdminUserController {
@@ -35,6 +40,7 @@ public class AdminUserController {
      * 查询当前管理员权限，与上面getCurrentUserInfo内容一样，不同在于增加了 @ValidatePermission
      * @return
      */
+    @ApiOperation("查询当前管理员账号信息")
     @ValidatePermission
     @GetMapping("/getCurrentAdminUserInfo")
     public APIResponseBean getCurrentAdminUserInfo() {
@@ -50,6 +56,7 @@ public class AdminUserController {
      * @param userId
      * @return
      */
+    @ApiOperation("设置黑名单接口")
     @ValidatePermission(role = RoleCodeEnum.ADMIN)
     @PostMapping("/addBlackListRole/{userId}")
     public APIResponseBean addBlackList(@PathVariable String userId) {
@@ -62,6 +69,7 @@ public class AdminUserController {
      * @param userId
      * @return
      */
+    @ApiOperation("升级管理员角色")
     @ValidatePermission(role = RoleCodeEnum.ADMIN)
     @PostMapping("/upgradeAdminRole/{userId}")
     public APIResponseBean upgradeAdminRole(@PathVariable String userId) {
@@ -74,6 +82,7 @@ public class AdminUserController {
      * @param userId
      * @return
      */
+    @ApiOperation("设置为普通用户角色")
     @ValidatePermission(role = RoleCodeEnum.ADMIN)
     @PostMapping("/setNormalUserRole/{userId}")
     public APIResponseBean cancelBlackListRole(@PathVariable String userId) {
@@ -81,6 +90,12 @@ public class AdminUserController {
         return APIResponseBeanUtil.success();
     }
 
+    @ApiOperation("用户列表查询")
+    @ApiImplicitParams({
+            @ApiImplicitParam(name = "roleCode", value = "角色CODE 1-普通用户\n 2-管理员\n 3-黑名单\n 4-群组\n 5-机器人\n 6-公众号", dataType = "Integer"),
+            @ApiImplicitParam(name = "pageNo", value = "页码，默认1", dataType = "Integer"),
+            @ApiImplicitParam(name = "pageSize", value = "页条数，默认8", dataType = "Integer")
+    })
     @ValidatePermission(role = RoleCodeEnum.ADMIN)
     @GetMapping("/getUserList")
     public APIPageResponseBean<List<UserSafeResponseInfoVO>> getUserList(

src/main/java/com/webchat/controller/admin/AdminUserWalletController.java

@@ -8,6 +8,8 @@ import com.webchat.common.helper.SessionHelper;
 import com.webchat.config.annotation.ValidatePermission;
 import com.webchat.domain.vo.response.UserWalletDetailResponseVO;
 import com.webchat.service.UserWalletService;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
@@ -23,6 +25,7 @@ import java.util.List;
  * @author 程序员七七， https://www.coderutil.com网站作者
  * @date 2024/11/9 05:34
  */
+@Api(tags = "【管理后台】用户钱包管理")
 @RestController
 @RequestMapping("/api/user/wallet")
 public class AdminUserWalletController {
@@ -35,6 +38,7 @@ public class AdminUserWalletController {
      *
      * @return
      */
+    @ApiOperation("管理员为用户钱包充值")
     @ValidatePermission
     @PostMapping("/grant/{userId}/{money}")
     public APIResponseBean<Boolean> grant(@PathVariable String userId, @PathVariable BigDecimal money) {
@@ -44,6 +48,7 @@ public class AdminUserWalletController {
         return APIResponseBeanUtil.success();
     }
 
+    @ApiOperation("钱包资金流转记录查询")
     @ValidatePermission
     @GetMapping("/page")
     public APIPageResponseBean<List<UserWalletDetailResponseVO>> page(

src/main/java/com/webchat/controller/admin/LotteryActivityController.java

@@ -12,6 +12,9 @@ import com.webchat.domain.vo.response.lottery.LotteryActivityVO;
 import com.webchat.service.UserWalletService;
 import com.webchat.service.lottery.LotteryActivityService;
 import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiImplicitParams;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.*;
 
@@ -24,7 +27,7 @@ import java.util.List;
  * @Date 2022/11/16 23:40
  * @description
  */
-@Api(tags = "【幸运抽奖】抽奖活动")
+@Api(tags = "【幸运抽奖】抽奖活动接口")
 @RestController
 @RequestMapping("/api/lottery/activity")
 public class LotteryActivityController {
@@ -40,6 +43,7 @@ public class LotteryActivityController {
      *
      * @return
      */
+    @ApiOperation("创建或更新抽奖活动")
     @ValidatePermission
     @PostMapping("/save")
     public APIResponseBean<Long> save(@RequestBody LotteryActivitySaveVO lotteryActivityVO) {
@@ -53,6 +57,7 @@ public class LotteryActivityController {
      * @param lotteryActivityStatusUpdate
      * @return
      */
+    @ApiOperation("更新活动状态")
     @ValidatePermission
     @PostMapping("/updateStatus")
     public APIResponseBean<Boolean> updateStatus(@RequestBody LotteryActivityStatusUpdateVO lotteryActivityStatusUpdate) {
@@ -67,6 +72,7 @@ public class LotteryActivityController {
      * @param lotteryActivityId
      * @return
      */
+    @ApiOperation("抽奖活动详情查询")
     @GetMapping("/detail/{lotteryActivityId}")
     public APIResponseBean<LotteryActivityVO> detail(@PathVariable String lotteryActivityId) {
         LotteryActivityVO lotteryActivity = lotteryActivityService.getLotteryActivityDetailFromCache(lotteryActivityId);
@@ -80,6 +86,7 @@ public class LotteryActivityController {
      *
      * @return
      */
+    @ApiOperation("最新一期活动信息查询")
     @GetMapping("/last")
     public APIResponseBean<LotteryActivityVO> last() {
         return APIResponseBeanUtil.success(lotteryActivityService.getLastLotteryActivityBaseFromCache());
@@ -90,6 +97,7 @@ public class LotteryActivityController {
      *
      * @return
      */
+    @ApiOperation("最新一期活动ID查询")
     @GetMapping("/lastId")
     public APIResponseBean<String> lastId() {
         return APIResponseBeanUtil.success(lotteryActivityService.getLastLotteryActivityIdFromCache());
@@ -102,9 +110,14 @@ public class LotteryActivityController {
      * @param size
      * @return
      */
+    @ApiOperation("历史活动列表查询")
+    @ApiImplicitParams({
+            @ApiImplicitParam(name = "lastId", value = "活动id", dataType = "Long"),
+            @ApiImplicitParam(name = "size", value = "条数，默认8", dataType = "Integer")
+    })
     @GetMapping("/history/list")
     public APIResponseBean<List<LotteryActivityVO>> queryHistory(@RequestParam(value = "lastId", required = false) Long lastId,
-                                                                 @RequestParam(value = "lastId", required = false, defaultValue = "8") Integer size) {
+                                                                 @RequestParam(value = "size", required = false, defaultValue = "8") Integer size) {
 
 
         return APIResponseBeanUtil.success(lotteryActivityService.getHistoryActivityList(lastId, size));
@@ -118,6 +131,13 @@ public class LotteryActivityController {
      * @param pageSize
      * @return
      */
+    @ApiOperation("活动列表检索")
+    @ApiImplicitParams({
+            @ApiImplicitParam(name = "name", value = "活动名称", dataType = "String"),
+            @ApiImplicitParam(name = "status", value = "状态", dataType = "Integer"),
+            @ApiImplicitParam(name = "pageNo", value = "页码，默认1", dataType = "Integer"),
+            @ApiImplicitParam(name = "pageSize", value = "页条数，默认8", dataType = "Integer")
+    })
     @ValidatePermission
     @GetMapping("/page")
     public APIPageResponseBean<List<LotteryActivityBaseVO>> page(@RequestParam(value = "name", required = false) String name,

src/main/java/com/webchat/controller/admin/LotteryController.java

@@ -8,6 +8,7 @@ import com.webchat.config.annotation.ValidateLogin;
 import com.webchat.domain.vo.response.lottery.LotteryDrawBulkResponseVO;
 import com.webchat.service.lottery.LotteryService;
 import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.PostMapping;
@@ -34,6 +35,7 @@ public class LotteryController {
      * 抽奖
      * @return
      */
+    @ApiOperation("单次抽奖")
     @ValidateLogin
     @SafeClick(event = ClickEvent.LUCK_LOTTERY, time = 5000L, message = "异常操作多次后账号将会永久拉黑")
     @PostMapping("/luckDraw/{lotteryActivityId}")
@@ -46,6 +48,7 @@ public class LotteryController {
      * 抽奖
      * @return
      */
+    @ApiOperation("十连抽奖")
     @ValidateLogin
     @SafeClick(event = ClickEvent.SUBMIT, time = 5000L, message = "异常操作多次后账号将会永久拉黑")
     @PostMapping("/luckDraw/{lotteryActivityId}/10")

src/main/java/com/webchat/controller/admin/LotteryItemController.java

@@ -9,6 +9,7 @@ import com.webchat.domain.vo.request.lottery.LotteryItemSaveVO;
 import com.webchat.domain.vo.response.lottery.LotteryItemVO;
 import com.webchat.service.lottery.LotteryItemService;
 import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.*;
 
@@ -32,6 +33,7 @@ public class LotteryItemController {
      * 新建或更新奖品信息
      * @return
      */
+    @ApiOperation("新建或更新奖品信息")
     @ValidatePermission
     @PostMapping("/save")
     public APIResponseBean<Long> save(@RequestBody LotteryItemSaveVO lotteryItemSaveVO) {
@@ -40,7 +42,7 @@ public class LotteryItemController {
     }
 
     /**
-     * 商品列表查询
+     * 奖品列表查询
      * @param name
      * @param slot
      * @param activityId
@@ -48,6 +50,7 @@ public class LotteryItemController {
      * @param pageSize
      * @return
      */
+    @ApiOperation("奖品列表查询")
     @ValidatePermission
     @GetMapping("/page")
     public APIPageResponseBean<List<LotteryItemVO>> pageList(@RequestParam(value = "activityId", required = false) String activityId,

src/main/java/com/webchat/controller/admin/LotteryOrderController.java

@@ -9,6 +9,9 @@ import com.webchat.domain.vo.request.lottery.LotteryOrderStatusUpdateVO;
 import com.webchat.domain.vo.response.lottery.LotteryUserOrderVO;
 import com.webchat.service.lottery.LotteryOrderService;
 import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiImplicitParam;
+import io.swagger.annotations.ApiImplicitParams;
+import io.swagger.annotations.ApiOperation;
 import org.apache.commons.lang3.StringUtils;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.*;
@@ -22,7 +25,7 @@ import java.util.List;
  * @Date 2022/11/16 23:40
  * @description
  */
-@Api(tags = "【幸运抽奖】订单服务")
+@Api(tags = "【幸运抽奖】订单管理")
 @RestController
 @RequestMapping("/api/lottery/order")
 public class LotteryOrderController {
@@ -36,6 +39,7 @@ public class LotteryOrderController {
      *
      * @return
      */
+    @ApiOperation("查询当前登录用户中奖订单")
     @GetMapping("/byCurrUser/{activityId}")
     public APIResponseBean<List<LotteryUserOrderVO>> listUserOrder(@PathVariable String activityId) {
         String userId = SessionHelper.getCurrentUserId();
@@ -51,6 +55,7 @@ public class LotteryOrderController {
      * @param activityId
      * @return
      */
+    @ApiOperation("查询活动下的TOP50中奖订单记录")
     @GetMapping("/byActivity/{activityId}")
     public APIResponseBean<List<LotteryUserOrderVO>> listActivityOrder(@PathVariable String activityId) {
         String userId = SessionHelper.getCurrentUserId();
@@ -64,6 +69,14 @@ public class LotteryOrderController {
      * 订单详情翻页
      * @return
      */
+    @ApiOperation("中奖订单列表查询")
+    @ApiImplicitParams({
+            @ApiImplicitParam(name = "activityId", value = "活动ID", dataType = "Long"),
+            @ApiImplicitParam(name = "orderId", value = "订单ID", dataType = "Long"),
+            @ApiImplicitParam(name = "status", value = "状态", dataType = "Integer"),
+            @ApiImplicitParam(name = "pageNo", value = "页码，默认1", dataType = "Integer"),
+            @ApiImplicitParam(name = "pageSize", value = "页条数，默认8", dataType = "Integer")
+    })
     @ValidatePermission
     @GetMapping("/page")
     public APIPageResponseBean<List<LotteryUserOrderVO>> pageList(@RequestParam(value = "activityId", required = false) String activityId,
@@ -80,6 +93,7 @@ public class LotteryOrderController {
      * @param lotteryOrderStatusUpdate
      * @return
      */
+    @ApiOperation("更新活动状态")
     @ValidatePermission
     @PostMapping("/updateStatus")
     public APIResponseBean<Boolean> updateStatus(@RequestBody LotteryOrderStatusUpdateVO lotteryOrderStatusUpdate) {

src/main/java/com/webchat/controller/client/ArticleController.java

@@ -13,6 +13,7 @@ import com.webchat.config.annotation.ValidatePermission;
 import com.webchat.domain.vo.request.publicaccount.SaveArticleRequestVO;
 import com.webchat.domain.vo.response.publicaccount.ArticleBaseResponseVO;
 import com.webchat.service.publicaccount.ArticleService;
+import io.swagger.annotations.Api;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
@@ -24,6 +25,7 @@ import org.springframework.web.bind.annotation.RestController;
 
 import java.util.List;
 
+@Api(tags = "【客户端】公众号文章管理")
 @RestController
 @RequestMapping("/api/article")
 public class ArticleController {

src/main/java/com/webchat/controller/client/ChatMessController.java

@@ -9,6 +9,7 @@ import com.webchat.domain.vo.request.mess.ChatMessageRequestVO;
 import com.webchat.domain.vo.response.mess.ChatMessageResponseVO;
 import com.webchat.domain.vo.response.mess.UserMessListResponseVO;
 import com.webchat.service.ChatMessService;
+import io.swagger.annotations.Api;
 import org.apache.commons.lang3.StringUtils;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.*;
@@ -21,6 +22,7 @@ import java.util.List;
  * @Date 2022/12/10 22:29
  * @description
  */
+@Api(tags = "【客户端】对话消息服务")
 @RestController
 @RequestMapping("/api/chat/mess")
 public class ChatMessController {

src/main/java/com/webchat/controller/client/ChatWebSocket.java

@@ -10,6 +10,7 @@ import com.webchat.domain.vo.response.mess.ChatMessageResponseVO;
 import com.webchat.service.UserService;
 import com.webchat.service.ai.AiAgentFlowService;
 import com.webchat.service.listener.RedisMessageSender;
+import io.swagger.annotations.Api;
 import lombok.Data;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.collections.CollectionUtils;
@@ -32,6 +33,7 @@ import java.util.concurrent.ConcurrentHashMap;
  * OnMessage 表示浏览器发消息的时候被调用
  * OnError 表示有错误发生，比如网络断开了等等
  */
+@Api(tags = "【WS长链接】基础对话WebSocket Endpoint")
 @Data
 @Slf4j
 @Component

src/main/java/com/webchat/controller/client/FriendController.java

@@ -7,6 +7,7 @@ import com.webchat.config.annotation.ValidateLogin;
 import com.webchat.domain.vo.response.FriendApplyUserVO;
 import com.webchat.domain.vo.response.UserBaseResponseInfoVO;
 import com.webchat.service.FriendService;
+import io.swagger.annotations.Api;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.*;
 
@@ -18,6 +19,7 @@ import java.util.List;
  * @Date 2022/12/10 15:39
  * @description
  */
+@Api(tags = "【客户端】好友关系服务接口")
 @RestController
 @RequestMapping("/api/friend")
 public class FriendController {

src/main/java/com/webchat/controller/client/GroupVideoChatDcsWebSocket.java

@@ -6,6 +6,7 @@ import com.webchat.common.util.SpringContextUtil;
 import com.webchat.domain.vo.request.mess.VideoChatMessageRequestVO;
 import com.webchat.domain.vo.response.UserBaseResponseInfoVO;
 import com.webchat.service.listener.RedisMessageSender;
+import io.swagger.annotations.Api;
 import lombok.Data;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.collections.MapUtils;
@@ -26,6 +27,7 @@ import java.util.Map;
 import java.util.Set;
 import java.util.concurrent.ConcurrentHashMap;
 
+@Api(tags = "【音视频】分布式群聊信令服务")
 @Data
 @Slf4j
 @Component

src/main/java/com/webchat/controller/client/GroupVideoChatWebSocket.java

@@ -8,6 +8,7 @@ import com.webchat.domain.vo.request.mess.VideoChatMessageRequestVO;
 import com.webchat.domain.vo.response.UserBaseResponseInfoVO;
 import com.webchat.service.UserService;
 import com.webchat.service.listener.RedisMessageSender;
+import io.swagger.annotations.Api;
 import lombok.Data;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.collections.CollectionUtils;
@@ -33,6 +34,7 @@ import java.util.Set;
 import java.util.concurrent.ArrayBlockingQueue;
 import java.util.concurrent.ConcurrentHashMap;
 
+@Api(tags = "【音视频】群聊信令服务")
 @Data
 @Slf4j
 @Component

src/main/java/com/webchat/controller/client/MessageController.java

@@ -7,6 +7,7 @@ import com.webchat.domain.vo.response.MessageResponseVO;
 import com.webchat.domain.vo.response.UserUnReadMessageCountVO;
 import com.webchat.service.UserService;
 import com.webchat.service.message.MessageService;
+import io.swagger.annotations.Api;
 import org.apache.commons.lang3.StringUtils;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -20,6 +21,7 @@ import java.util.List;
  * @Author: 程序员七七 https://www.coderutil.com
  * @Description: 无描述信息
  */
+@Api(tags = "【客户端】消息服务接口")
 @RestController
 @RequestMapping("/api/message")
 public class MessageController {

src/main/java/com/webchat/controller/client/MomentController.java

@@ -26,6 +26,7 @@ import java.util.List;
  * @Date: 2021-7-11 0011 16:05
  * @Description: 无描述信息
  */
+@Api(tags = "【客户端】朋友圈动态服务接口")
 @RestController
 @RequestMapping("/api/moment")
 public class MomentController {

src/main/java/com/webchat/controller/client/PublicAccountController.java

@@ -4,6 +4,7 @@ import com.webchat.common.bean.APIResponseBean;
 import com.webchat.common.bean.APIResponseBeanUtil;
 import com.webchat.domain.vo.response.publicaccount.PublicAccountVO;
 import com.webchat.service.publicaccount.PublicAccountService;
+import io.swagger.annotations.Api;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -11,6 +12,7 @@ import org.springframework.web.bind.annotation.RestController;
 
 import java.util.List;
 
+@Api(tags = "【客户端】公众号服务接口")
 @RestController
 @RequestMapping("/api/public-account")
 public class PublicAccountController {

src/main/java/com/webchat/controller/client/QRController.java

@@ -2,6 +2,7 @@ package com.webchat.controller.client;
 
 import com.webchat.common.util.MD5Utils;
 import com.webchat.common.util.QRCodeUtils;
+import io.swagger.annotations.Api;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -19,6 +20,7 @@ import java.io.FileInputStream;
  * @author 程序员七七，https://www.coderutil.com
  * @date 2024/11/8 00:33
  */
+@Api(tags = "【基础服务】二维码服务")
 @Slf4j
 @RestController
 @RequestMapping("/api/qr")

src/main/java/com/webchat/controller/client/RAGBotController.java

@@ -10,6 +10,7 @@ import com.webchat.common.util.ThreadPoolExecutorUtil;
 import com.webchat.config.annotation.ValidateLogin;
 import com.webchat.domain.vo.llm.LLMChatRequestDTO;
 import com.webchat.service.ai.RAGBotService;
+import io.swagger.annotations.Api;
 import org.apache.commons.lang3.StringUtils;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.util.Assert;
@@ -18,6 +19,7 @@ import org.springframework.web.servlet.mvc.method.annotation.SseEmitter;
 
 import javax.servlet.http.HttpServletRequest;
 
+@Api(tags = "【AI大模型】RAG搜索增强问答助手服务")
 @RestController
 @RequestMapping("/api/rag/bot")
 public class RAGBotController {

src/main/java/com/webchat/controller/client/RedPacketController.java

@@ -8,6 +8,7 @@ import com.webchat.config.annotation.SafeClick;
 import com.webchat.config.annotation.ValidateLogin;
 import com.webchat.domain.vo.request.SendRedPacketRequestVO;
 import com.webchat.service.RedPacketService;
+import io.swagger.annotations.Api;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
@@ -20,6 +21,7 @@ import org.springframework.web.bind.annotation.RestController;
  * @author 程序员七七， https://www.coderutil.com网站作者
  * @date 2024/11/9 03:27
  */
+@Api(tags = "【客户端】红包收发服务接口")
 @RestController
 @RequestMapping("/api/red-packet")
 public class RedPacketController {

src/main/java/com/webchat/controller/client/ResourceBehaviorController.java

@@ -8,12 +8,14 @@ import com.webchat.domain.vo.request.ResourceBehaviorRequestVO;
 import com.webchat.service.UserService;
 import com.webchat.service.behavior.AbstractResourceBehaviorService;
 import com.webchat.service.behavior.ResourceBehaviorFactory;
+import io.swagger.annotations.Api;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
+@Api(tags = "【客户端】基础通用互动服务接口")
 @RestController
 @RequestMapping("/api/resource")
 public class ResourceBehaviorController {

src/main/java/com/webchat/controller/client/RobotChatController.java

@@ -4,6 +4,7 @@ import com.webchat.common.exception.BusinessException;
 import com.webchat.common.helper.SessionHelper;
 import com.webchat.common.helper.SseEmitterHelper;
 import com.webchat.config.annotation.ValidateLogin;
+import io.swagger.annotations.Api;
 import org.apache.commons.lang3.StringUtils;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -18,6 +19,7 @@ import javax.servlet.http.HttpServletRequest;
  * @Date 2024/10/29 23:54
  * @description
  */
+@Api(tags = "【AI大模型】机器人对话SSE服务")
 @RestController
 @RequestMapping("/api/robot/chat")
 public class RobotChatController {

src/main/java/com/webchat/controller/client/SearchController.java

@@ -9,6 +9,7 @@ import com.webchat.common.helper.SessionHelper;
 import com.webchat.config.annotation.ValidatePermission;
 import com.webchat.domain.vo.dto.AbstractBaseEsDTO;
 import com.webchat.service.elastic.WebChatElasticSearchService;
+import io.swagger.annotations.Api;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -17,6 +18,7 @@ import org.springframework.web.bind.annotation.RestController;
 
 import java.util.List;
 
+@Api(tags = "【搜索引擎】消息搜索服务接口")
 @RestController
 @RequestMapping("/api/search")
 public class SearchController {

src/main/java/com/webchat/controller/client/UserController.java

@@ -22,6 +22,7 @@ import com.webchat.domain.vo.response.UserBaseResponseInfoVO;
 import com.webchat.service.SlideVerificationService;
 import com.webchat.service.UserService;
 import com.webchat.service.ValidCodeService;
+import io.swagger.annotations.Api;
 import org.apache.commons.lang3.StringUtils;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.util.Assert;
@@ -34,6 +35,7 @@ import java.util.List;
 /**
  * 用户服务API
  */
+@Api(tags = "【客户端】基础用户/账号服务接口")
 @RestController
 @RequestMapping("/api/user")
 public class UserController {

src/main/java/com/webchat/controller/client/UserWalletController.java

@@ -5,6 +5,7 @@ import com.webchat.common.bean.APIResponseBeanUtil;
 import com.webchat.common.helper.SessionHelper;
 import com.webchat.config.annotation.ValidateLogin;
 import com.webchat.service.UserWalletService;
+import io.swagger.annotations.Api;
 import org.apache.commons.lang3.StringUtils;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -17,6 +18,7 @@ import java.math.BigDecimal;
  * @author 程序员七七， https://www.coderutil.com网站作者
  * @date 2024/11/9 05:34
  */
+@Api(tags = "【客户端】用户钱包服务接口")
 @RestController
 @RequestMapping("/api/user/wallet")
 public class UserWalletController {

src/main/java/com/webchat/controller/client/ValidCodeController.java

@@ -3,6 +3,7 @@ package com.webchat.controller.client;
 import com.webchat.common.util.PicValidCodeUtil;
 import com.webchat.common.util.obj.PicValidCodeResult;
 import com.webchat.service.ValidCodeService;
+import io.swagger.annotations.Api;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -16,6 +17,7 @@ import java.awt.image.BufferedImage;
 /**
  * 图形验证码
  */
+@Api(tags = "【基础能力】图形验证码服务")
 @Slf4j
 @RestController
 @RequestMapping("/api/valid-code")

src/main/java/com/webchat/controller/client/VideoChatWebDcsSocket.java

@@ -5,6 +5,7 @@ import com.webchat.common.util.JsonUtil;
 import com.webchat.common.util.SpringContextUtil;
 import com.webchat.domain.vo.request.mess.VideoChatMessageRequestVO;
 import com.webchat.service.listener.RedisMessageSender;
+import io.swagger.annotations.Api;
 import lombok.Data;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.stereotype.Component;
@@ -19,6 +20,7 @@ import java.util.concurrent.ConcurrentHashMap;
 
 import javax.websocket.*;
 
+@Api(tags = "【音视频】分布式一对一信令服务")
 @Data
 @Slf4j
 @Component

src/main/java/com/webchat/controller/client/VideoChatWebSocket.java

@@ -6,6 +6,7 @@ import com.webchat.domain.vo.request.mess.VideoChatMessageRequestVO;
 import com.webchat.domain.vo.response.UserBaseResponseInfoVO;
 import com.webchat.domain.vo.response.mess.ChatMessageResponseVO;
 import com.webchat.service.UserService;
+import io.swagger.annotations.Api;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.collections.CollectionUtils;
 import org.springframework.stereotype.Component;
@@ -24,6 +25,7 @@ import java.util.Map;
 import java.util.Set;
 import java.util.concurrent.ConcurrentHashMap;
 
+@Api(tags = "【音视频】一对一信令服务")
 @Slf4j
 @Component
 @ServerEndpoint(value = "/ws/video-chat/{userId}")

src/main/java/com/webchat/domain/vo/request/CommentSaveVO.java

@@ -1,5 +1,6 @@
 package com.webchat.domain.vo.request;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -10,19 +11,27 @@ import lombok.Data;
 @Data
 public class CommentSaveVO {
 
+    @ApiModelProperty("资源id")
     private Long resourceId;
 
+    @ApiModelProperty("栏目id")
     private Long pathId;
 
+    @ApiModelProperty("资源类型")
     private String resourceType;
 
+    @ApiModelProperty("回复评论id")
     private Long replyId;
 
+    @ApiModelProperty("评论正文")
     private String content;
 
+    @ApiModelProperty("图片，多个图片英文逗号分割")
     private String images;
 
+    @ApiModelProperty("作者id")
     private String authorId;
 
+    @ApiModelProperty("是否匿名")
     private Boolean isAnonymous = false;
 }

src/main/java/com/webchat/domain/vo/request/CreateGroupRequestVO.java

@@ -1,5 +1,6 @@
 package com.webchat.domain.vo.request;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 import java.util.Set;
@@ -10,15 +11,12 @@ import java.util.Set;
 @Data
 public class CreateGroupRequestVO {
 
-    /**
-     * 群组名称
-     */
+    @ApiModelProperty("群组名称")
     private String groupName;
 
-    /**
-     * 群组用户
-     */
+    @ApiModelProperty("群组用户")
     private Set<String> userIds;
 
+    @ApiModelProperty("创建人id，无需前端传递")
     private String createUserId;
 }

src/main/java/com/webchat/domain/vo/request/CreatePublicAccountRequestVO.java

@@ -1,5 +1,6 @@
 package com.webchat.domain.vo.request;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -10,24 +11,16 @@ public class CreatePublicAccountRequestVO {
 
     private Long id;
 
-    /**
-     * 公众号账号，类似java
-     */
+    @ApiModelProperty("公众号账号，类似java")
     private String account;
 
-    /**
-     * 机器人名称
-     */
+    @ApiModelProperty("机器人名称")
     private String accountName;
 
-    /**
-     * 头像
-     */
+    @ApiModelProperty("头像")
     private String accountPhoto;
 
-    /**
-     * 公众号简介
-     */
+    @ApiModelProperty("公众号简介")
     private String signature;
 
     private String createUserId;

src/main/java/com/webchat/domain/vo/request/CreateRobotRequestVO.java

@@ -1,5 +1,6 @@
 package com.webchat.domain.vo.request;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 import java.util.Set;
@@ -12,24 +13,16 @@ public class CreateRobotRequestVO {
 
     private Long id;
 
-    /**
-     * 机器人账号，类似 robot1、gpt等自定义英文账号
-     */
+    @ApiModelProperty("机器人账号，类似 robot1、gpt等自定义英文账号")
     private String robotNumber;
 
-    /**
-     * 机器人名称
-     */
+    @ApiModelProperty("机器人名称")
     private String robotName;
 
-    /**
-     * 头像
-     */
+    @ApiModelProperty("头像")
     private String robotPhoto;
 
-    /**
-     * 机器人角色
-     */
+    @ApiModelProperty("机器人角色")
     private String robotRole;
 
     private String createUserId;

src/main/java/com/webchat/domain/vo/request/MomentSaveOrUpdateVO.java

@@ -1,5 +1,6 @@
 package com.webchat.domain.vo.request;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 import java.util.List;
@@ -14,28 +15,18 @@ public class MomentSaveOrUpdateVO {
 
     protected Long id;
 
-    /***
-     * 正文
-     */
+    @ApiModelProperty("动态正文")
     private String content;
 
-    /**
-     * 图片
-     */
+    @ApiModelProperty("图片")
     private List<String> images;
 
-    /***
-     * 视频
-     */
+    @ApiModelProperty("视频")
     private String video;
 
-    /***
-     * 作者
-     */
+    @ApiModelProperty("作者")
     private String author;
 
-    /***
-     * 客户端
-     */
+    @ApiModelProperty("客户端")
     private String client;
 }

src/main/java/com/webchat/domain/vo/request/ResourceBehaviorRequestVO.java

@@ -1,5 +1,6 @@
 package com.webchat.domain.vo.request;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import org.apache.commons.lang3.StringUtils;
 import org.springframework.util.Assert;
@@ -7,10 +8,13 @@ import org.springframework.util.Assert;
 @Data
 public class ResourceBehaviorRequestVO {
 
+    @ApiModelProperty("资源id")
     private Long resourceId;
 
+    @ApiModelProperty("资源类型")
     private String resourceType;
 
+    @ApiModelProperty("互动类型")
     private String behaviorType;
 
     public void validRequestParam() {

src/main/java/com/webchat/domain/vo/request/SendRedPacketRequestVO.java

@@ -1,5 +1,6 @@
 package com.webchat.domain.vo.request;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import org.apache.commons.lang3.StringUtils;
 import org.springframework.util.Assert;
@@ -13,29 +14,19 @@ import java.math.BigDecimal;
 @Data
 public class SendRedPacketRequestVO {
 
-    /**
-     * 红包发送人
-     */
+    @ApiModelProperty("红包发送人")
     private String sendUserId;
 
-    /**
-     * 接收人，可能是人 / 群
-     */
+    @ApiModelProperty("接收人，可能是人 / 群")
     private String receiverUserId;
 
-    /**
-     * 拼手气、普通红包（平均分配）
-     */
+    @ApiModelProperty("拼手气、普通红包（平均分配）")
     private Integer type;
 
-    /**
-     * 总金额
-     */
+    @ApiModelProperty("总金额")
     private BigDecimal totalMoney;
 
-    /**
-     * 一共几个，发给个人只能一次拆一个，发给群聊可以配置多个
-     */
+    @ApiModelProperty("一共几个，发给个人只能一次拆一个，发给群聊可以配置多个")
     private Integer count;
 
 

src/main/java/com/webchat/domain/vo/request/SlideVerificationVO.java

@@ -1,5 +1,6 @@
 package com.webchat.domain.vo.request;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -11,11 +12,15 @@ import lombok.Data;
 @Data
 public class SlideVerificationVO {
 
+    @ApiModelProperty("id")
     private String id;
 
+    @ApiModelProperty("图片")
     private String image;
 
+    @ApiModelProperty("x坐标")
     private Integer x;
 
+    @ApiModelProperty("y坐标")
     private Integer y;
 }

src/main/java/com/webchat/domain/vo/request/UpdateUserInfoRequestVO.java

@@ -1,5 +1,6 @@
 package com.webchat.domain.vo.request;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -9,18 +10,12 @@ import lombok.Data;
 public class UpdateUserInfoRequestVO {
 
 
-    /**
-     * 用户id
-     */
+    @ApiModelProperty("用户id")
     private String userId;
 
-    /**
-     * 修改头像
-     */
+    @ApiModelProperty("修改头像")
     private String photo;
 
-    /**
-     * 修改用户昵称
-     */
+    @ApiModelProperty("修改用户昵称")
     private String userName;
 }

src/main/java/com/webchat/domain/vo/request/UserLoginInfoRequestVO.java

@@ -1,19 +1,17 @@
 package com.webchat.domain.vo.request;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 @Data
 public class UserLoginInfoRequestVO {
 
-    /**
-     * 手机号
-     */
+    @ApiModelProperty("手机号")
     private String mobile;
 
-    /**
-     * 密码
-     */
+    @ApiModelProperty("密码")
     private String password;
 
+    @ApiModelProperty("滑块验证tokenId")
     private String solidTokenId;
 }

src/main/java/com/webchat/domain/vo/request/UserRegistryInfoRequestVO.java

@@ -1,5 +1,6 @@
 package com.webchat.domain.vo.request;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /***
@@ -10,28 +11,18 @@ public class UserRegistryInfoRequestVO {
 
     private String photo;
 
-    /**
-     * 用户名
-     */
+    @ApiModelProperty("用户名")
     private String userName;
 
-    /**
-     * 用户ID
-     */
+    @ApiModelProperty("用户ID")
     private String userId;
 
-    /**
-     * 手机号
-     */
+    @ApiModelProperty("手机号")
     private String mobile;
 
-    /**
-     * 密码
-     */
+    @ApiModelProperty("密码")
     private String password;
 
-    /***
-     * 数字验证码
-     */
+    @ApiModelProperty("数字验证码")
     private String picCheckCode;
 }

src/main/java/com/webchat/domain/vo/request/lottery/LotteryActivitySaveVO.java

@@ -1,5 +1,6 @@
 package com.webchat.domain.vo.request.lottery;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 import java.math.BigDecimal;
@@ -13,29 +14,19 @@ import java.math.BigDecimal;
 @Data
 public class LotteryActivitySaveVO {
 
-    /**
-     * 活动id
-     */
+    @ApiModelProperty("活动id")
     private Long id;
 
-    /**
-     * 活动名称
-     */
+    @ApiModelProperty("活动名称")
     private String name;
 
-    /**
-     * 活动描述
-     */
+    @ApiModelProperty("活动描述")
     private String description;
 
-    /**
-     * 活动海报图
-     */
+    @ApiModelProperty("活动封面图")
     private String cover;
 
-    /**
-     * 每次抽奖需要消耗钱数
-     */
+    @ApiModelProperty("每次抽奖需要消耗钱数")
     private BigDecimal money;
 
 }

src/main/java/com/webchat/domain/vo/request/lottery/LotteryActivityStatusUpdateVO.java

@@ -1,5 +1,6 @@
 package com.webchat.domain.vo.request.lottery;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -11,14 +12,9 @@ import lombok.Data;
 @Data
 public class LotteryActivityStatusUpdateVO {
 
-    /**
-     * 活动id
-     */
+    @ApiModelProperty("活动id")
     private String activityId;
 
-    /**
-     * 更新抽奖活动状态
-     * @see com.coder.common.constants.LotteryConstants.LotteryActivityStatus
-     */
+    @ApiModelProperty("更新抽奖活动状态: 1-筹备中\n 2-进行中\n 3-已结束\n 4-已删除")
     private Integer status;
 }

src/main/java/com/webchat/domain/vo/request/lottery/LotteryItemSaveVO.java

@@ -1,5 +1,6 @@
 package com.webchat.domain.vo.request.lottery;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -11,44 +12,27 @@ import lombok.Data;
 @Data
 public class LotteryItemSaveVO {
 
-    /**
-     * 活动id
-     */
+    @ApiModelProperty("奖品id")
     private Long id;
 
-    /**
-     * 关联活动ID
-     */
+    @ApiModelProperty("关联活动ID")
     private String activityId;
 
-    /**
-     * 商品类型
-     * @see com.coder.common.constants.LotteryConstants.LotteryItemType
-     */
+    @ApiModelProperty("商品类型")
     private Integer type;
 
-    /**
-     * 奖品名称
-     */
+    @ApiModelProperty("奖品名称")
     private String name;
 
-    /**
-     * 奖品icon
-     */
+    @ApiModelProperty("奖品icon")
     private String icon;
 
-    /**
-     * 奖品封面图
-     */
+    @ApiModelProperty("奖品封面图")
     private String cover;
 
-    /**
-     * 卡槽 1，2，3 ...... 8
-     */
+    @ApiModelProperty("卡槽 1，2，3 ...... 8")
     private Integer slot;
 
-    /**
-     * 库存数量
-     */
+    @ApiModelProperty("库存数量")
     private Integer stock;
 }

src/main/java/com/webchat/domain/vo/request/lottery/LotteryOrderStatusUpdateVO.java

@@ -1,5 +1,6 @@
 package com.webchat.domain.vo.request.lottery;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -11,14 +12,9 @@ import lombok.Data;
 @Data
 public class LotteryOrderStatusUpdateVO {
 
-    /**
-     * 活动id
-     */
+    @ApiModelProperty("订单ID")
     private String orderId;
 
-    /**
-     * 更新抽奖活动状态
-     * @see com.coder.common.constants.LotteryConstants.LotteryOrderStatus
-     */
+    @ApiModelProperty("订单状态 1-未兑换\n 2-已兑换\n 3-已删除")
     private Integer status;
 }

src/main/java/com/webchat/domain/vo/request/lottery/LotterySponsorSaveVO.java

@@ -1,43 +0,0 @@
-package com.webchat.domain.vo.request.lottery;
-
-import lombok.Data;
-
-/**
- * @Author 程序员七七
- * @webSite https://www.coderutil.com
- * @Date 2022/11/16 22:53
- * @description 抽奖活动赞助商配置
- */
-@Data
-public class LotterySponsorSaveVO {
-
-    /**
-     * 活动id
-     */
-    private Long id;
-
-    /**
-     * 关联活动ID
-     */
-    private String activityId;
-
-    /**
-     * 赞助商logo
-     */
-    private String logo;
-
-    /**
-     * 赞助推广链接
-     */
-    private String url;
-
-    /**
-     * 赞助话术
-     */
-    private String content;
-
-    /**
-     * 评分
-     */
-    private Integer score;
-}

src/main/java/com/webchat/domain/vo/request/mess/ChatMessageRequestVO.java

@@ -1,5 +1,6 @@
 package com.webchat.domain.vo.request.mess;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 
@@ -9,10 +10,9 @@ import lombok.Data;
 @Data
 public class ChatMessageRequestVO extends MessageBaseVO {
 
-    /**
-     * 消息图片
-     */
+    @ApiModelProperty("消息图片")
     private String image;
 
+    @ApiModelProperty("拒接音视频")
     private Boolean rejectVideoOffer = false;
 }

src/main/java/com/webchat/domain/vo/request/mess/MessageBaseVO.java

@@ -1,6 +1,7 @@
 package com.webchat.domain.vo.request.mess;
 
 import com.webchat.common.enums.ChatMessageTypeEnum;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -9,29 +10,22 @@ import lombok.Data;
 @Data
 public class MessageBaseVO {
 
-    /**
-     * 当前用户ID
-     */
+    @ApiModelProperty("当前用户ID")
     private String senderId;
 
-    /**
-     * 聊天对象用户ID
-     */
+    @ApiModelProperty("聊天对象用户ID")
     private String receiverId;
 
-    /**
-     * 代理用户（群聊真是消息发送用户）
-     */
+    @ApiModelProperty("代理用户（群聊真是消息发送用户）")
     private String proxySenderId;
 
-    /**
-     * 消息文本正文
-     */
+    @ApiModelProperty("消息文本正文")
     private String message;
 
     /**
      * 类型
      * @see com.webchat.common.enums.ChatMessageTypeEnum
      */
+    @ApiModelProperty("类型")
     private Integer type = ChatMessageTypeEnum.CHAT_TEXT.getType();
 }

src/main/java/com/webchat/domain/vo/request/mess/VideoChatMessageRequestVO.java

@@ -1,5 +1,6 @@
 package com.webchat.domain.vo.request.mess;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 
@@ -9,18 +10,25 @@ import lombok.Data;
 @Data
 public class VideoChatMessageRequestVO {
 
+    @ApiModelProperty("发送人id")
     private String userId;
 
+    @ApiModelProperty("接受人id")
     private String targetUserId;
 
+    @ApiModelProperty("群聊id")
     private String groupId;
 
+    @ApiModelProperty("类型")
     private String type;
 
+    @ApiModelProperty("candidate")
     private Object candidate;
 
+    @ApiModelProperty("answer")
     private Object answer;
 
+    @ApiModelProperty("offer")
     private Object offer;
 
 }

src/main/java/com/webchat/domain/vo/request/publicaccount/SaveArticleRequestVO.java

@@ -1,5 +1,6 @@
 package com.webchat.domain.vo.request.publicaccount;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -8,55 +9,34 @@ import lombok.Data;
 @Data
 public class SaveArticleRequestVO {
 
-    /**
-     * 文章id
-     */
+    @ApiModelProperty("文章id")
     private Long id;
 
-    /**
-     * 作者
-     */
+    @ApiModelProperty("作者")
     private String author;
 
-    /**
-     * 公众号
-     */
+    @ApiModelProperty("公众号")
     private String publicAccount;
 
-    /**
-     * 文章计划推送时间，13位时间戳，精确到秒
-     */
+    @ApiModelProperty("文章计划推送时间，13位时间戳，精确到秒")
     private Long planPushTime;
 
-
-    /**
-     * 文章标题
-     */
+    @ApiModelProperty("文章标题")
     private String title;
 
-    /**
-     * 文章封面主图
-     */
+    @ApiModelProperty("文章封面主图")
     private String cover;
 
-    /**
-     * 文章总结
-     */
+    @ApiModelProperty("文章总结")
     private String description;
 
-    /**
-     * 文章正文
-     */
+    @ApiModelProperty("文章正文")
     private String content;
 
-    /**
-     * 文章标签
-     */
+    @ApiModelProperty("文章标签")
     private String signs;
 
-    /**
-     * 文章跳转链接（配置了该链接，默认跳转到链接指向地址，扩展公众号推送能力）
-     */
+    @ApiModelProperty("文章跳转链接（配置了该链接，默认跳转到链接指向地址，扩展公众号推送能力）")
     private String redirectUrl;
 
     /**
@@ -64,6 +44,7 @@ public class SaveArticleRequestVO {
      *
      * @see com.webchat.common.enums.ArticleStatusEnum
      */
+    @ApiModelProperty("文章状态")
     private Integer status;
 
 

src/main/java/com/webchat/domain/vo/response/CommentOutResponseVO.java

@@ -1,5 +1,6 @@
 package com.webchat.domain.vo.response;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -12,13 +13,18 @@ public class CommentOutResponseVO {
 
     private Long id;
 
+    @ApiModelProperty("评论作者id")
     private String author;
 
+    @ApiModelProperty("回复评论作者id")
     private String replyAuthor;
 
+    @ApiModelProperty("评论正文")
     private String content;
 
+    @ApiModelProperty("评论作者")
     private UserBaseResponseInfoVO authorInfo;
 
+    @ApiModelProperty("回复评论作者")
     private UserBaseResponseInfoVO replyAuthorInfo;
 }

src/main/java/com/webchat/domain/vo/response/CommentResponseVO.java

@@ -1,5 +1,6 @@
 package com.webchat.domain.vo.response;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import org.apache.commons.lang3.StringUtils;
 
@@ -18,34 +19,48 @@ public class CommentResponseVO {
 
     private Long id;
 
+    @ApiModelProperty("评论作者id")
     private String author;
 
+    @ApiModelProperty("资源id")
     private Long resourceId;
 
+    @ApiModelProperty("资源类型")
     private String resourceType;
 
+    @ApiModelProperty("评论正文")
     private String content;
 
+    @ApiModelProperty("图片")
     private String images;
 
+    @ApiModelProperty("图片列表")
     private List<String> imageList;
 
+    @ApiModelProperty("状态")
     private String status;
 
+    @ApiModelProperty("点赞量")
     private Long likeCount;
 
+    @ApiModelProperty("发布时间")
     private Date pubDate;
 
+    @ApiModelProperty("发布时间")
     private Long pubTime;
 
+    @ApiModelProperty("发布时间")
     private String pubDateStr;
 
     private Boolean permission = false;
 
+    @ApiModelProperty("评论作者")
     private UserBaseResponseInfoVO authorInfo;
 
+    @ApiModelProperty("父评论")
     private CommentResponseVO reply;
 
+    @ApiModelProperty("回复评论列表")
     private List<CommentResponseVO> replyToList;
 
     public List<String> getImageList() {

src/main/java/com/webchat/domain/vo/response/EditorUpdateResultResponse.java

@@ -1,20 +0,0 @@
-package com.webchat.domain.vo.response;
-
-import lombok.Data;
-
-@Data
-public class EditorUpdateResultResponse {
-
-
-    private Integer errno = 0;
-
-    private EditorUpdateResultResponseVO data;
-
-
-    public static EditorUpdateResultResponse of(Integer errno, EditorUpdateResultResponseVO data) {
-        EditorUpdateResultResponse response = new EditorUpdateResultResponse();
-        response.setErrno(errno);
-        response.setData(data);
-        return response;
-    }
-}

src/main/java/com/webchat/domain/vo/response/EditorUploadResultResponse.java

@@ -0,0 +1,20 @@
+package com.webchat.domain.vo.response;
+
+import lombok.Data;
+
+@Data
+public class EditorUploadResultResponse {
+
+
+    private Integer errno = 0;
+
+    private EditorUploadResultResponseVO data;
+
+
+    public static EditorUploadResultResponse of(Integer errno, EditorUploadResultResponseVO data) {
+        EditorUploadResultResponse response = new EditorUploadResultResponse();
+        response.setErrno(errno);
+        response.setData(data);
+        return response;
+    }
+}

src/main/java/com/webchat/domain/vo/response/EditorUpdateResultResponseVO.java → src/main/java/com/webchat/domain/vo/response/EditorUploadResultResponseVO.java

@@ -8,7 +8,7 @@ import lombok.NoArgsConstructor;
 @Data
 @NoArgsConstructor
 @AllArgsConstructor
-public class EditorUpdateResultResponseVO {
+public class EditorUploadResultResponseVO {
 
     private String url;
     private String alt;
@@ -17,7 +17,7 @@ public class EditorUpdateResultResponseVO {
     private String format;
 
 
-    public EditorUpdateResultResponseVO(String url) {
+    public EditorUploadResultResponseVO(String url) {
         this.url = url;
     }
 }

src/main/java/com/webchat/domain/vo/response/FriendApplyUserVO.java

@@ -1,5 +1,6 @@
 package com.webchat.domain.vo.response;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.NoArgsConstructor;
@@ -17,7 +18,9 @@ public class FriendApplyUserVO {
 
     private Long applyId;
 
+    @ApiModelProperty("申请时间")
     private Long applyTime;
 
+    @ApiModelProperty("申请用户")
     private UserBaseResponseInfoVO applyUser;
 }

src/main/java/com/webchat/domain/vo/response/GroupResponseInfoVO.java

@@ -1,5 +1,6 @@
 package com.webchat.domain.vo.response;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 
@@ -9,23 +10,15 @@ import lombok.Data;
 @Data
 public class GroupResponseInfoVO {
 
-    /**
-     * id
-     */
+    @ApiModelProperty("id")
     private Long id;
 
-    /**
-     * 群聊id
-     */
+    @ApiModelProperty("群聊id")
     private String groupId;
 
-    /**
-     * 群聊名称
-     */
+    @ApiModelProperty("群聊名称")
     private String groupName;
 
-    /**
-     * 群聊下面有多少用户
-     */
+    @ApiModelProperty("群聊下面有多少用户")
     private Integer userCount;
 }

src/main/java/com/webchat/domain/vo/response/MomentResponseDetailVO.java

@@ -22,7 +22,7 @@ public class MomentResponseDetailVO extends MomentResponseBaseVO {
 
     private Long commentCount = 0L;
 
-    /***
+    /**
      * 是否有删除权限
      */
     private Boolean hasDeleteAuth = false;
@@ -31,7 +31,7 @@ public class MomentResponseDetailVO extends MomentResponseBaseVO {
 
     private List<UserBaseResponseInfoVO> likeUsers;
 
-    /***
+    /**
      * 外显评论
      */
     private List<CommentOutResponseVO> outComments;

src/main/java/com/webchat/domain/vo/response/OpenRedPacketVO.java

@@ -1,5 +1,6 @@
 package com.webchat.domain.vo.response;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -9,18 +10,12 @@ import lombok.Data;
 @Data
 public class OpenRedPacketVO {
 
-    /**
-     * 拆分用户
-     */
+    @ApiModelProperty("拆分用户")
     private String userId;
 
-    /**
-     * 拆分金额
-     */
+    @ApiModelProperty("拆分金额")
     private String money;
 
-    /**
-     * 拆包时间
-     */
+    @ApiModelProperty("拆包时间")
     private Long time;
 }

src/main/java/com/webchat/domain/vo/response/RedPacketDetailVO.java

@@ -1,5 +1,6 @@
 package com.webchat.domain.vo.response;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 import java.math.BigDecimal;
@@ -11,53 +12,33 @@ import java.math.BigDecimal;
 @Data
 public class RedPacketDetailVO {
 
-    /**
-     * 红包id
-     */
+    @ApiModelProperty("红包id")
     private Long id;
 
-    /**
-     * 红包发送人信息
-     */
+    @ApiModelProperty("红包发送人信息")
     private String sendUserId;
 
-    /**
-     * 红包接受人信息：普通用户或者群聊
-     */
+    @ApiModelProperty("红包接受人信息：普通用户或者群聊")
     private String receiverUserId;
 
-    /**
-     * 拼手气、普通红包（平均分配）
-     */
+    @ApiModelProperty("拼手气、普通红包（平均分配）")
     private Integer type;
 
-    /**
-     * 总金额
-     */
+    @ApiModelProperty("总金额")
     private BigDecimal totalMoney;
 
-    /**
-     * 一共几个，发给个人只能一次拆一个，发给群聊可以配置多个
-     */
+    @ApiModelProperty("一共几个，发给个人只能一次拆一个，发给群聊可以配置多个")
     private Integer count;
 
-    /**
-     * 状态
-     */
+    @ApiModelProperty("状态")
     private Integer status;
 
-    /**
-     * 发送时间
-     */
+    @ApiModelProperty("发送时间")
     private Long sendTime;
 
-    /**
-     * 失效时间
-     */
+    @ApiModelProperty("失效时间")
     private Long expireTime;
 
-    /**
-     * 是否有抢到
-     */
+    @ApiModelProperty("是否有抢到")
     private boolean isGet;
 }

src/main/java/com/webchat/domain/vo/response/ResourceSimpleCardVO.java

@@ -1,5 +1,6 @@
 package com.webchat.domain.vo.response;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -12,12 +13,12 @@ public class ResourceSimpleCardVO {
 
     private Object id;
 
-    /***
-     * 资源类型
-     */
+    @ApiModelProperty("类型")
     private String type;
 
+    @ApiModelProperty("标题")
     private String title;
 
+    @ApiModelProperty("首图")
     private String firstImage;
 }

src/main/java/com/webchat/domain/vo/response/UploadResultVO.java

@@ -1,5 +1,6 @@
 package com.webchat.domain.vo.response;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -9,10 +10,13 @@ import lombok.Data;
 @Data
 public class UploadResultVO {
 
+    @ApiModelProperty("资源链接")
     private String url;
 
+    @ApiModelProperty("资源名称")
     private String name;
 
+    @ApiModelProperty("上传资源类型")
     private String type;
 
     public static UploadResultVO of(String url, String type, String name) {

src/main/java/com/webchat/domain/vo/response/UserBaseResponseInfoVO.java

@@ -1,5 +1,6 @@
 package com.webchat.domain.vo.response;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 
@@ -11,41 +12,28 @@ public class UserBaseResponseInfoVO {
 
     private Long id;
 
-    /**
-     * 用户ID
-     */
+    @ApiModelProperty("用户ID")
     private String userId;
 
-    /**
-     * 头像
-     */
+    @ApiModelProperty("头像")
     private String photo;
 
-    /***
-     * 性别
-     */
+    @ApiModelProperty("性别")
     private String sex;
 
-    /**
-     * 签名
-     */
+    @ApiModelProperty("签名")
     private String signature;
 
-    /**
-     * 用户名
-     */
+    @ApiModelProperty("用户名")
     private String userName;
 
-    /***
-     * 手机号
-     */
+    @ApiModelProperty("手机号")
     private String mobile;
 
+    @ApiModelProperty("角色code")
     private Integer roleCode;
 
-    /***
-     * 注册时间
-     */
+    @ApiModelProperty("注册时间")
     private Long registryTime;
 
     private String registryTimeStr;

src/main/java/com/webchat/domain/vo/response/UserSafeResponseInfoVO.java

@@ -9,8 +9,4 @@ import lombok.Data;
 public class UserSafeResponseInfoVO extends UserBaseResponseInfoVO {
 
     private String mobile;
-
-    private Long registryTime;
-
-    private String registryTimeStr;
 }

src/main/java/com/webchat/domain/vo/response/UserUnReadMessageCountVO.java

@@ -1,5 +1,6 @@
 package com.webchat.domain.vo.response;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -10,27 +11,19 @@ import lombok.Data;
 @Data
 public class UserUnReadMessageCountVO {
 
-    /***
-     * 未读点赞消息数
-     */
+    @ApiModelProperty("未读点赞消息数")
     private Long unReadLikeMessageCount = 0L;
 
-    /***
-     * 未读评论消息数
-     */
+    @ApiModelProperty("未读评论消息数")
     private Long unReadCommentMessageCount = 0L;
 
-    /***
-     * 未读系统消息数
-     */
+    @ApiModelProperty("未读系统消息数")
     private Long unReadSystemMessageCount = 0L;
 
-    /***
-     * 未读粉丝关注消息数
-     */
+    @ApiModelProperty("未读粉丝关注消息数")
     private Long unReadFocusMessageCount = 0L;
 
-    /***
+    /**
      * 全部未读消息数
      * @return
      */

src/main/java/com/webchat/domain/vo/response/UserWalletDetailResponseVO.java

@@ -1,21 +1,31 @@
 package com.webchat.domain.vo.response;
 
 import com.webchat.common.util.DateUtils;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 import java.util.Date;
 
 /**
- * @author wangqi49@baidu.com
+ * @author 王七七
  * @date 2024/11/9 15:26
  */
 @Data
 public class UserWalletDetailResponseVO {
 
+    @ApiModelProperty("用户详情")
     private UserBaseResponseInfoVO user;
+
+    @ApiModelProperty("交易事件类型")
     private String event;
+
+    @ApiModelProperty("金额流转类型")
     private Integer type;
+
+    @ApiModelProperty("流转金钱")
     private String money;
+
+    @ApiModelProperty("交易时间")
     private Long time;
 
     public String getTimeStr() {

src/main/java/com/webchat/domain/vo/response/lottery/LotteryActivityBaseVO.java

@@ -1,5 +1,6 @@
 package com.webchat.domain.vo.response.lottery;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 import java.math.BigDecimal;
@@ -15,50 +16,33 @@ public class LotteryActivityBaseVO {
 
     private Long id;
 
-    /**
-     * 活动id
-     */
+    @ApiModelProperty("活动id")
     private String activityId;
 
-    /**
-     * 活动名称
-     */
+    @ApiModelProperty("活动名称")
     private String name;
 
-    /**
-     * 活动描述
-     */
+    @ApiModelProperty("活动描述")
     private String description;
 
-    /**
-     * 每抽奖一次需要消耗的金币
-     */
+    @ApiModelProperty("每抽奖一次需要消耗的金币")
     private Integer integral;
 
-    /**
-     * 活动海报图
-     */
+    @ApiModelProperty("活动海报图")
     private String cover;
 
-    /**
-     * 每次抽奖需要消耗的钱数
-     */
+    @ApiModelProperty("每次抽奖需要消耗的钱数")
     private BigDecimal money;
 
-    /**
-     * 用户初始钱包余额
-     */
+    @ApiModelProperty("用户初始钱包余额")
     private BigDecimal userInitWalletBalance;
 
-    /**
-     * 活动当前状态
-     */
+    @ApiModelProperty("活动当前状态")
     private Integer status;
 
-    /**
-     * 状态名称
-     */
+    @ApiModelProperty("状态名称")
     private String statusName;
 
+    @ApiModelProperty("创建时间")
     private Long createTime;
 }

src/main/java/com/webchat/domain/vo/response/lottery/LotteryActivityVO.java

@@ -2,6 +2,7 @@ package com.webchat.domain.vo.response.lottery;
 
 import com.webchat.common.constants.LotteryConstants;
 import com.webchat.common.exception.BusinessException;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import org.springframework.util.Assert;
 
@@ -16,9 +17,7 @@ import java.util.List;
 @Data
 public class LotteryActivityVO extends LotteryActivityBaseVO {
 
-    /**
-     * 抽奖选项
-     */
+    @ApiModelProperty("抽奖选项")
     private List<LotteryItemVO> items;
 
 

src/main/java/com/webchat/domain/vo/response/lottery/LotteryDrawBaseResponseVO.java

@@ -1,5 +1,6 @@
 package com.webchat.domain.vo.response.lottery;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 import java.math.BigDecimal;
@@ -7,8 +8,6 @@ import java.math.BigDecimal;
 @Data
 public class LotteryDrawBaseResponseVO {
 
-    /**
-     * 用户最新余额
-     */
+    @ApiModelProperty("用户最新余额")
     private BigDecimal walletBalance;
 }

src/main/java/com/webchat/domain/vo/response/lottery/LotteryDrawBulkResponseVO.java

@@ -1,5 +1,6 @@
 package com.webchat.domain.vo.response.lottery;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.NoArgsConstructor;
@@ -12,9 +13,7 @@ import java.util.List;
 @AllArgsConstructor
 public class LotteryDrawBulkResponseVO extends LotteryDrawBaseResponseVO {
 
-    /**
-     * 批量抽奖结果
-     */
+    @ApiModelProperty("批量抽奖结果")
     private List<Long> itemIdList;
 
     public static LotteryDrawBulkResponseVO of(BigDecimal walletBalance, List<Long> itemIdList) {

src/main/java/com/webchat/domain/vo/response/lottery/LotteryDrawOneResponseVO.java

@@ -1,5 +1,6 @@
 package com.webchat.domain.vo.response.lottery;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.AllArgsConstructor;
 import lombok.Data;
 import lombok.NoArgsConstructor;
@@ -11,9 +12,7 @@ import java.math.BigDecimal;
 @AllArgsConstructor
 public class LotteryDrawOneResponseVO extends LotteryDrawBaseResponseVO {
 
-    /**
-     * 用户最新余额
-     */
+    @ApiModelProperty("单次抽奖中奖奖品ID")
     private Long itemId;
 
 

src/main/java/com/webchat/domain/vo/response/lottery/LotteryItemVO.java

@@ -1,6 +1,7 @@
 package com.webchat.domain.vo.response.lottery;
 
 import com.webchat.common.constants.LotteryConstants;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -12,46 +13,31 @@ import lombok.Data;
 @Data
 public class LotteryItemVO {
 
-    /**
-     * 奖项id
-     */
+    @ApiModelProperty("奖项id")
     private Long id;
 
-    /**
-     * 关联活动ID
-     */
+    @ApiModelProperty("关联活动ID")
     private String activityId;
 
-    /**
-     * 商品类型
-     */
+    @ApiModelProperty("商品类型")
     private Integer type;
 
+    @ApiModelProperty("类型名称")
     private String typeName;
 
-    /**
-     * 奖品名称
-     */
+    @ApiModelProperty("奖品名称")
     private String name;
 
-    /**
-     * 奖品icon
-     */
+    @ApiModelProperty("奖品icon")
     private String icon;
 
-    /**
-     * 奖品封面图
-     */
+    @ApiModelProperty("奖品封面图")
     private String cover;
 
-    /**
-     * 卡槽 1，2，3 ...... 8
-     */
+    @ApiModelProperty("卡槽 1，2，3 ...... 8")
     private Integer slot;
 
-    /**
-     * 库存数量
-     */
+    @ApiModelProperty("库存数量")
     private Integer stock;
 
     private Long createTime;

src/main/java/com/webchat/domain/vo/response/lottery/LotterySponsorVO.java

@@ -1,43 +0,0 @@
-package com.webchat.domain.vo.response.lottery;
-
-import lombok.Data;
-
-/**
- * @Author 程序员七七
- * @webSite https://www.coderutil.com
- * @Date 2022/11/18 01:36
- * @description
- */
-@Data
-public class LotterySponsorVO {
-
-    /**
-     * 活动id
-     */
-    private Long id;
-
-    /**
-     * 关联活动ID
-     */
-    private String activityId;
-
-    /**
-     * 赞助商logo
-     */
-    private String logo;
-
-    /**
-     * 赞助推广链接
-     */
-    private String url;
-
-    /**
-     * 赞助话术
-     */
-    private String content;
-
-    /**
-     * 评分
-     */
-    private Integer score;
-}

src/main/java/com/webchat/domain/vo/response/lottery/LotteryUserOrderVO.java

@@ -1,6 +1,7 @@
 package com.webchat.domain.vo.response.lottery;
 
 import com.webchat.domain.vo.response.UserBaseResponseInfoVO;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /**
@@ -12,43 +13,27 @@ import lombok.Data;
 @Data
 public class LotteryUserOrderVO {
 
-    /**
-     * 订单号
-     */
+    @ApiModelProperty("订单号")
     private String orderId;
 
-    /**
-     * 中奖用户
-     */
+    @ApiModelProperty("中奖用户")
     private UserBaseResponseInfoVO user;
 
-    /**
-     * 活动
-     */
+    @ApiModelProperty("活动")
     private LotteryActivityBaseVO activity;
 
-    /**
-     * 中奖商品
-     */
+    @ApiModelProperty("中奖商品")
     private LotteryItemVO item;
 
-    /**
-     * 订单状态code
-     */
+    @ApiModelProperty("订单状态code")
     private Integer orderStatus;
 
-    /**
-     * 订单状态
-     */
+    @ApiModelProperty("订单状态")
     private String orderStatusName;
 
-    /**
-     * 中奖时间
-     */
+    @ApiModelProperty("中奖时间")
     private long luckTime;
 
-    /**
-     * 兑换时间
-     */
+    @ApiModelProperty("兑换时间")
     private long exchangeTime;
 }

src/main/java/com/webchat/domain/vo/response/mess/ChatMessageResponseVO.java

@@ -3,6 +3,7 @@ package com.webchat.domain.vo.response.mess;
 
 import com.webchat.domain.vo.response.RedPacketDetailVO;
 import com.webchat.domain.vo.response.UserBaseResponseInfoVO;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 import org.apache.commons.lang3.ObjectUtils;
 import org.apache.commons.lang3.StringUtils;
@@ -10,83 +11,61 @@ import org.apache.commons.lang3.StringUtils;
 @Data
 public class ChatMessageResponseVO {
 
-
-    /**
-     * 对话消息类型
-     */
+    @ApiModelProperty("对话消息类型")
     private Integer type;
 
-    /***
-     * 消息ID
-     */
+    @ApiModelProperty("消息ID")
     private Long messId;
 
-    /***
-     * 当前用户
-     */
+    @ApiModelProperty("")
     private String senderId;
+    @ApiModelProperty("消息发送人详情")
     private UserBaseResponseInfoVO sender;
 
-    /**
-     * 消息代理对象（适用于群聊场景）
-     */
+    @ApiModelProperty("消息代理对象ID（适用于群聊场景）")
     private String proxySenderId;
+    @ApiModelProperty("消息代理对象（适用于群聊场景）")
     private UserBaseResponseInfoVO proxySender;
 
-    /***
-     * 聊天对象
-     */
+    @ApiModelProperty("消息接受人id")
     private String receiverId;
+    @ApiModelProperty("消息接受人详情")
     private UserBaseResponseInfoVO receiver;
 
-    /***
-     * 消息文本正文
-     */
+    @ApiModelProperty("消息文本正文")
     private String message;
 
-    /***
-     * 消息图片
-     */
+    @ApiModelProperty("消息图片")
     private String image;
 
-    /***
-     * 消息发送时间
-     */
+    @ApiModelProperty("消息发送时间")
     private Long time;
 
-    /***
-     * 消息状态
-     */
+    @ApiModelProperty("消息状态")
     private Boolean isRead;
 
-    /**
-     * 是否来自群组消息
-     */
+    @ApiModelProperty("是否来自群组消息")
     private Boolean groupMessage = false;
 
-    /**
-     * 来自红包通知
-     */
+    @ApiModelProperty("来自红包通知")
     private Boolean redPacket = false;
-    /**
-     * 红包信息
-     */
+
+    @ApiModelProperty("红包详情")
     private RedPacketDetailVO redPacketDetail;
 
-    /**
-     * 消息文章
-     */
+    @ApiModelProperty("公众号文章详情")
     private PublicAccountArticleMessageVO publicAccountArticle;
 
-    /**
-     * 是否来自音视频offer
-     */
+    @ApiModelProperty("是否来自音视频offer")
     private Boolean videoOffer = false;
 
+    @ApiModelProperty("拒绝接受音视频")
     private Boolean rejectVideoOffer = false;
 
+    @ApiModelProperty("来自朋友圈的消息")
     private Boolean momentMessage = false;
 
+    @ApiModelProperty("发送人姓名")
     private String senderName;
 
 

src/main/java/com/webchat/domain/vo/response/mess/PublicAccountArticleMessageVO.java

@@ -1,22 +1,26 @@
 package com.webchat.domain.vo.response.mess;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 @Data
 public class PublicAccountArticleMessageVO {
 
+    @ApiModelProperty("文章id")
     private Long articleId;
 
+    @ApiModelProperty("封面图")
     private String cover;
 
+    @ApiModelProperty("标题")
     private String title;
 
+    @ApiModelProperty("文章推送时间")
     private Long time;
 
+    @ApiModelProperty("公众号文章描述")
     private String description;
 
-    /**
-     * 外部链接，优先跳转
-     */
+    @ApiModelProperty("外部链接，优先跳转")
     private String redirectUrl;
 }

src/main/java/com/webchat/domain/vo/response/mess/UserMessListResponseVO.java

@@ -2,6 +2,7 @@ package com.webchat.domain.vo.response.mess;
 
 
 import com.webchat.domain.vo.response.UserBaseResponseInfoVO;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 /***
@@ -10,23 +11,15 @@ import lombok.Data;
 @Data
 public class UserMessListResponseVO {
 
-    /***
-     * 当前用户
-     */
+    @ApiModelProperty("当前用户")
     private UserBaseResponseInfoVO user;
 
-    /***
-     * 消息文本正文
-     */
+    @ApiModelProperty("消息文本正文")
     private String lastMessage;
 
-    /***
-     * 消息发送时间
-     */
+    @ApiModelProperty("消息发送时间")
     private Long time;
 
-    /***
-     * 未读消息数
-     */
+    @ApiModelProperty("是否有未读消息")
     private boolean unReadMess = false;
 }

src/main/java/com/webchat/domain/vo/response/publicaccount/ArticleBaseResponseVO.java

@@ -1,65 +1,46 @@
 package com.webchat.domain.vo.response.publicaccount;
 
 import com.webchat.domain.vo.response.UserBaseResponseInfoVO;
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 @Data
 public class ArticleBaseResponseVO {
 
-    /**
-     * 文章id
-     */
+    @ApiModelProperty("id")
     private Long id;
 
-    /**
-     * 作者
-     */
+    @ApiModelProperty("作者")
     private String author;
 
-    /**
-     * 公众号
-     */
+    @ApiModelProperty("公众号id")
     private String publicAccount;
 
+    @ApiModelProperty("公众号文章详情")
     private UserBaseResponseInfoVO publicAccountInfo;
 
-    /**
-     * 文章计划推送时间，13位时间戳，精确到秒
-     */
+    @ApiModelProperty("文章计划推送时间，13位时间戳，精确到秒")
     private Long planPushTime;
 
-
+    @ApiModelProperty("发布时间")
     private Long publishTime;
 
-
-    /**
-     * 文章标题
-     */
+    @ApiModelProperty("文章标题")
     private String title;
 
-    /**
-     * 文章封面主图
-     */
+    @ApiModelProperty("文章封面主图")
     private String cover;
 
-    /**
-     * 文章总结
-     */
+    @ApiModelProperty("文章总结")
     private String description;
 
-    /**
-     * 文章正文
-     */
+    @ApiModelProperty("文章正文")
     private String content;
 
-    /**
-     * 文章标签
-     */
+    @ApiModelProperty("文章标签")
     private String signs;
 
-    /**
-     * 文章跳转链接
-     */
+    @ApiModelProperty("文章跳转链接")
     private String redirectUrl;
 
     /**
@@ -67,5 +48,6 @@ public class ArticleBaseResponseVO {
      *
      * @see com.webchat.common.enums.ArticleStatusEnum
      */
+    @ApiModelProperty("文章推送状态 1-待推送\n 2-已推送")
     private Integer status;
 }

src/main/java/com/webchat/domain/vo/response/publicaccount/PublicAccountVO.java

@@ -1,13 +1,17 @@
 package com.webchat.domain.vo.response.publicaccount;
 
+import io.swagger.annotations.ApiModelProperty;
 import lombok.Data;
 
 @Data
 public class PublicAccountVO {
 
+    @ApiModelProperty("id")
     private String id;
 
+    @ApiModelProperty("公众号名称")
     private String name;
 
+    @ApiModelProperty("公众号头像")
     private String photo;
 }

src/main/java/com/webchat/service/lottery/LotteryOrderService.java

@@ -98,7 +98,6 @@ public class LotteryOrderService {
         log.info("抽奖抽中金币，消息消费内容：{}", JsonUtil.toJsonString(lotteryOrder));
         String activityId = lotteryOrder.getActivityId();
         Long itemId = lotteryOrder.getItemId();
-        String userId = lotteryOrder.getUserId();
         LotteryItemVO lotteryItemVO = lotteryCacheService.getLotteryItemVOFromCache(activityId, itemId);
         if (lotteryItemVO == null) {
             return lotteryOrder;
@@ -108,8 +107,6 @@ public class LotteryOrderService {
             log.info("抽奖未抽中金币，消息消费内容：{}", JsonUtil.toJsonString(lotteryOrder));
             return lotteryOrder;
         }
-        String name = lotteryItemVO.getName();
-        String countStr = name.substring(name.indexOf("X") + 1);
         /**
          * 修改订单状态
          */