Commit 758dfcbb80df43a24a552dd3d40663315725a348

Authored by YunaiV
1 parent ef19ad39

📝 docs(controller): 移除控制器类中的作者注释

Showing 15 changed files with 65 additions and 63 deletions
yudao-module-im/yudao-module-im-biz/src/main/java/cn/iocoder/yudao/module/im/controller/admin/friend/ImFriendController.java 0 → 100644
  1 +package cn.iocoder.yudao.module.im.controller.admin.friend;
  2 +
  3 +import cn.iocoder.yudao.framework.common.pojo.CommonResult;
  4 +import cn.iocoder.yudao.framework.security.core.util.SecurityFrameworkUtils;
  5 +import cn.iocoder.yudao.module.im.controller.admin.friend.vo.ImFriendRespVO;
  6 +import cn.iocoder.yudao.module.im.service.friend.ImFriendService;
  7 +import io.swagger.v3.oas.annotations.Operation;
  8 +import io.swagger.v3.oas.annotations.Parameter;
  9 +import io.swagger.v3.oas.annotations.tags.Tag;
  10 +import jakarta.annotation.Resource;
  11 +import jakarta.validation.constraints.NotNull;
  12 +import org.springframework.validation.annotation.Validated;
  13 +import org.springframework.web.bind.annotation.*;
  14 +
  15 +import java.util.List;
  16 +
  17 +import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
  18 +
  19 +@Tag(name = "管理后台 - IM 好友")
  20 +@RestController
  21 +@RequestMapping("/im/friend")
  22 +@Validated
  23 +public class ImFriendController {
  24 +
  25 + @Resource
  26 + private ImFriendService friendService;
  27 +
  28 + @GetMapping("/list")
  29 + @Operation(summary = "获得当前登录用户的好友列表")
  30 + public CommonResult<List<ImFriendRespVO>> getMyFriendList() {
  31 + Long userId = SecurityFrameworkUtils.getLoginUserId();
  32 + return success(friendService.getMyFriendList(userId));
  33 + }
  34 +
  35 + @GetMapping("/get")
  36 + @Operation(summary = "获得好友详情")
  37 + @Parameter(name = "friendUserId", description = "好友的用户编号", required = true, example = "2048")
  38 + public CommonResult<ImFriendRespVO> getFriend(@RequestParam("friendUserId") Long friendUserId) {
  39 + Long userId = SecurityFrameworkUtils.getLoginUserId();
  40 + return success(friendService.getFriend(userId, friendUserId));
  41 + }
  42 +
  43 + @PostMapping("/add")
  44 + @Operation(summary = "添加好友(双向建立关系)")
  45 + @Parameter(name = "friendUserId", description = "好友的用户编号", required = true, example = "2048")
  46 + public CommonResult<Boolean> addFriend(
  47 + @RequestParam("friendUserId") @NotNull(message = "好友用户编号不能为空") Long friendUserId) {
  48 + Long userId = SecurityFrameworkUtils.getLoginUserId();
  49 + friendService.addFriend(userId, friendUserId);
  50 + return success(true);
  51 + }
  52 +
  53 + @DeleteMapping("/delete")
  54 + @Operation(summary = "删除好友(双向软删除)")
  55 + @Parameter(name = "friendUserId", description = "好友的用户编号", required = true, example = "2048")
  56 + public CommonResult<Boolean> deleteFriend(
  57 + @RequestParam("friendUserId") @NotNull(message = "好友用户编号不能为空") Long friendUserId) {
  58 + Long userId = SecurityFrameworkUtils.getLoginUserId();
  59 + friendService.deleteFriend(userId, friendUserId);
  60 + return success(true);
  61 + }
  62 +
  63 + // TODO @AI:增加一个 updateFriend 接口,目前暂时就 dnd(免打扰)功能,后续可以增加备注等功能
  64 +
  65 +}
... ...
yudao-module-im/yudao-module-im-biz/src/main/java/cn/iocoder/yudao/module/im/controller/admin/message/ImGroupMessageController.java
... ... @@ -20,9 +20,6 @@ import java.util.List;
20 20 import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
21 21 import static cn.iocoder.yudao.framework.security.core.util.SecurityFrameworkUtils.getLoginUserId;
22 22  
23   -/**
24   - * 管理后台 - IM 群聊消息
25   - */
26 23 @Tag(name = "管理后台 - IM 群聊消息")
27 24 @RestController
28 25 @RequestMapping("/im/message/group")
... ...
yudao-module-im/yudao-module-im-biz/src/main/java/cn/iocoder/yudao/module/im/controller/admin/message/ImPrivateMessageController.java
... ... @@ -20,9 +20,6 @@ import java.util.List;
20 20 import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
21 21 import static cn.iocoder.yudao.framework.security.core.util.SecurityFrameworkUtils.getLoginUserId;
22 22  
23   -/**
24   - * 管理后台 - IM 私聊消息
25   - */
26 23 @Tag(name = "管理后台 - IM 私聊消息")
27 24 @RestController
28 25 @RequestMapping("/im/message/private")
... ...
yudao-module-mes/src/main/java/cn/iocoder/yudao/module/mes/controller/admin/wm/miscreceipt/MesWmMiscReceiptController.java
... ... @@ -26,11 +26,6 @@ import java.util.List;
26 26 import static cn.iocoder.yudao.framework.apilog.core.enums.OperateTypeEnum.EXPORT;
27 27 import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
28 28  
29   -/**
30   - * MES 杂项入库单 Controller
31   - *
32   - * @author 芋道源码
33   - */
34 29 @Tag(name = "管理后台 - MES 杂项入库单")
35 30 @RestController
36 31 @RequestMapping("/mes/wm/misc-receipt")
... ...
yudao-module-mes/src/main/java/cn/iocoder/yudao/module/mes/controller/admin/wm/miscreceipt/MesWmMiscReceiptLineController.java
... ... @@ -36,9 +36,6 @@ import cn.iocoder.yudao.module.mes.service.wm.warehouse.MesWmWarehouseService;
36 36 import cn.iocoder.yudao.module.mes.service.wm.warehouse.MesWmWarehouseLocationService;
37 37 import cn.iocoder.yudao.module.mes.service.wm.warehouse.MesWmWarehouseAreaService;
38 38  
39   -/**
40   - * MES 杂项入库单行 Controller
41   - */
42 39 @Tag(name = "管理后台 - MES 杂项入库单行")
43 40 @RestController
44 41 @RequestMapping("/mes/wm/misc-receipt-line")
... ...
yudao-module-mes/src/main/java/cn/iocoder/yudao/module/mes/controller/admin/wm/outsourceissue/MesWmOutsourceIssueController.java
... ... @@ -36,11 +36,6 @@ import static cn.iocoder.yudao.framework.apilog.core.enums.OperateTypeEnum.EXPOR
36 36 import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
37 37 import static cn.iocoder.yudao.framework.common.util.collection.CollectionUtils.convertSet;
38 38  
39   -/**
40   - * MES 外协发料单 Controller
41   - *
42   - * @author 芋道源码
43   - */
44 39 @Tag(name = "管理后台 - MES 外协发料单")
45 40 @RestController
46 41 @RequestMapping("/mes/wm/outsource-issue")
... ...
yudao-module-mes/src/main/java/cn/iocoder/yudao/module/mes/controller/admin/wm/outsourceissue/MesWmOutsourceIssueDetailController.java
... ... @@ -34,11 +34,6 @@ import java.util.Map;
34 34 import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
35 35 import static cn.iocoder.yudao.framework.common.util.collection.CollectionUtils.convertSet;
36 36  
37   -/**
38   - * MES 外协发料单明细 Controller
39   - *
40   - * @author 芋道源码
41   - */
42 37 @Tag(name = "管理后台 - MES 外协发料单明细")
43 38 @RestController
44 39 @RequestMapping("/mes/wm/outsource-issue-detail")
... ...
yudao-module-mes/src/main/java/cn/iocoder/yudao/module/mes/controller/admin/wm/outsourceissue/MesWmOutsourceIssueLineController.java
... ... @@ -34,11 +34,6 @@ import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
34 34 import static cn.iocoder.yudao.framework.common.util.collection.CollectionUtils.convertMap;
35 35 import static cn.iocoder.yudao.framework.common.util.collection.CollectionUtils.convertSet;
36 36  
37   -/**
38   - * MES 外协发料单行 Controller
39   - *
40   - * @author 芋道源码
41   - */
42 37 @Tag(name = "管理后台 - MES 外协发料单行")
43 38 @RestController
44 39 @RequestMapping("/mes/wm/outsource-issue-line")
... ...
yudao-module-mes/src/main/java/cn/iocoder/yudao/module/mes/controller/admin/wm/packages/MesWmPackageController.java
... ... @@ -32,12 +32,6 @@ import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
32 32 import static cn.iocoder.yudao.framework.common.util.collection.CollectionUtils.convertSet;
33 33 import static cn.iocoder.yudao.framework.common.util.collection.CollectionUtils.convertSetByFlatMap;
34 34  
35   -// DONE @AI:检查下 java 类,是不是 author 没加。
36   -/**
37   - * MES 装箱单 Controller
38   - *
39   - * @author 芋道源码
40   - */
41 35 @Tag(name = "管理后台 - MES 装箱单")
42 36 @RestController
43 37 @RequestMapping("/mes/wm/package")
... ...
yudao-module-mes/src/main/java/cn/iocoder/yudao/module/mes/controller/admin/wm/packages/MesWmPackageLineController.java
... ... @@ -32,11 +32,6 @@ import java.util.Map;
32 32 import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
33 33 import static cn.iocoder.yudao.framework.common.util.collection.CollectionUtils.convertSet;
34 34  
35   -/**
36   - * MES 装箱明细 Controller
37   - *
38   - * @author 芋道源码
39   - */
40 35 @Tag(name = "管理后台 - MES 装箱明细")
41 36 @RestController
42 37 @RequestMapping("/mes/wm/package-line")
... ...
yudao-module-mes/src/main/java/cn/iocoder/yudao/module/mes/controller/admin/wm/returnsales/MesWmReturnSalesController.java
... ... @@ -34,11 +34,6 @@ import static cn.iocoder.yudao.framework.apilog.core.enums.OperateTypeEnum.EXPOR
34 34 import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
35 35 import static cn.iocoder.yudao.framework.common.util.collection.CollectionUtils.convertSet;
36 36  
37   -/**
38   - * 管理后台 - MES 销售退货单 Controller
39   - *
40   - * @author 芋道源码
41   - */
42 37 @Tag(name = "管理后台 - MES 销售退货单")
43 38 @RestController
44 39 @RequestMapping("/mes/wm/return-sales")
... ...
yudao-module-mes/src/main/java/cn/iocoder/yudao/module/mes/controller/admin/wm/returnsales/MesWmReturnSalesDetailController.java
... ... @@ -34,11 +34,6 @@ import java.util.Map;
34 34 import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
35 35 import static cn.iocoder.yudao.framework.common.util.collection.CollectionUtils.convertSet;
36 36  
37   -/**
38   - * 管理后台 - MES 销售退货相关
39   - *
40   - * @author 芋道源码
41   - */
42 37 @Tag(name = "管理后台 - MES 销售退货明细")
43 38 @RestController
44 39 @RequestMapping("/mes/wm/return-sales-detail")
... ...
yudao-module-mes/src/main/java/cn/iocoder/yudao/module/mes/controller/admin/wm/returnsales/MesWmReturnSalesLineController.java
... ... @@ -30,11 +30,6 @@ import java.util.Map;
30 30 import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
31 31 import static cn.iocoder.yudao.framework.common.util.collection.CollectionUtils.convertSet;
32 32  
33   -/**
34   - * 管理后台 - MES 销售退货相关
35   - *
36   - * @author 芋道源码
37   - */
38 33 @Tag(name = "管理后台 - MES 销售退货单行")
39 34 @RestController
40 35 @RequestMapping("/mes/wm/return-sales-line")
... ...
yudao-module-pay/src/main/java/cn/iocoder/yudao/module/pay/controller/app/wallet/AppPayWalletController.java
... ... @@ -19,9 +19,6 @@ import jakarta.annotation.Resource;
19 19 import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
20 20 import static cn.iocoder.yudao.framework.security.core.util.SecurityFrameworkUtils.getLoginUserId;
21 21  
22   -/**
23   - * @author jason
24   - */
25 22 @Tag(name = "用户 APP - 钱包")
26 23 @RestController
27 24 @RequestMapping("/pay/wallet")
... ...
yudao-module-system/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/PermissionController.java
... ... @@ -20,11 +20,6 @@ import java.util.Set;
20 20  
21 21 import static cn.iocoder.yudao.framework.common.pojo.CommonResult.success;
22 22  
23   -/**
24   - * 权限 Controller,提供赋予用户、角色的权限的 API 接口
25   - *
26   - * @author 芋道源码
27   - */
28 23 @Tag(name = "管理后台 - 权限")
29 24 @RestController
30 25 @RequestMapping("/system/permission")
... ...