Bläddra i källkod

#MOD 接口文档相关,注解修改+torna-swagger插件源码包修改

谭斌 2 år sedan
förälder
incheckning
d9f6bfdf53

+ 2 - 0
authorize-api-cloud/src/main/java/com/xy/feign/SysWorkUserFeign.java

@@ -3,8 +3,10 @@ package com.xy.feign;
 import com.xy.FeignInterceptor;
 import com.xy.consts.ServiceConsts;
 import com.xy.service.SysWorkUserService;
+import io.swagger.annotations.Api;
 import org.springframework.cloud.openfeign.FeignClient;
 
+@Api(tags = "业务用户管理")
 @FeignClient(value = ServiceConsts.SERVICE_NAME, configuration = FeignInterceptor.class)
 public interface SysWorkUserFeign extends SysWorkUserService {
 

+ 0 - 2
authorize-api-service/src/main/java/com/xy/service/impl/AuthorizeServiceImpl.java

@@ -7,7 +7,6 @@ import com.xy.dto.SysMenuDto;
 import com.xy.redis.RedisCache;
 import com.xy.service.AuthorizeService;
 import com.xy.utils.R;
-import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
 import lombok.AllArgsConstructor;
 import org.springframework.stereotype.Service;
@@ -15,7 +14,6 @@ import org.springframework.stereotype.Service;
 import java.util.List;
 
 @Service
-@Api(tags = "鉴权相关接口")
 @AllArgsConstructor
 public class AuthorizeServiceImpl implements AuthorizeService {
 

+ 2 - 3
authorize-api-service/src/main/java/com/xy/service/impl/CaptchaServiceImpl.java

@@ -7,7 +7,6 @@ import com.anji.captcha.model.vo.CaptchaVO;
 import com.anji.captcha.util.StringUtils;
 import com.xy.error.CommRuntimeException;
 import com.xy.service.CaptchaService;
-import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
 import lombok.RequiredArgsConstructor;
 import org.springframework.stereotype.Service;
@@ -21,13 +20,13 @@ import javax.servlet.http.HttpServletRequest;
  * @author 谭斌
  * @date 2022/12/15 14:10
  */
-@Api(tags = "滑块验证码操作")
+
 @Service
 @RequiredArgsConstructor
 public class CaptchaServiceImpl implements CaptchaService {
 
     private final com.anji.captcha.service.CaptchaService captchaService;
- 
+
     @Override
     public Boolean reVerification(String captchaVerification) {
         CaptchaVO captchaVO = new CaptchaVO();

+ 1 - 2
authorize-api-service/src/main/java/com/xy/service/impl/SysDeptServiceImpl.java

@@ -22,7 +22,6 @@ import com.xy.service.SysUserDeptService;
 import com.xy.utils.LambdaUtils;
 import com.xy.utils.R;
 import com.xy.vo.SysDeptVo;
-import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
 import lombok.RequiredArgsConstructor;
 import org.springframework.stereotype.Service;
@@ -46,7 +45,7 @@ import static com.xy.utils.Beans.copy;
  * @author 谭斌
  * @date 2022/12/13 14:01
  */
-@Api(tags = "部门管理")
+
 @Service
 @RequiredArgsConstructor
 public class SysDeptServiceImpl extends ServiceImpl<SysDeptMapper, SysDept> implements SysDeptService {

+ 0 - 2
authorize-api-service/src/main/java/com/xy/service/impl/SysMenuServiceImpl.java

@@ -16,7 +16,6 @@ import com.xy.mapper.SysRoleMenuMapper;
 import com.xy.redis.RedisCache;
 import com.xy.service.SysMenuService;
 import com.xy.utils.R;
-import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
 import lombok.AllArgsConstructor;
 import org.springframework.stereotype.Service;
@@ -40,7 +39,6 @@ import static com.xy.utils.Beans.tree;
  */
 @Service
 @AllArgsConstructor
-@Api(tags = "菜单接口")
 public class SysMenuServiceImpl extends ServiceImpl<SysMenuMapper, SysMenu> implements SysMenuService {
 
     private SysRoleMenuMapper sysRoleMenuMapper;

+ 1 - 2
authorize-api-service/src/main/java/com/xy/service/impl/SysRoleServiceImpl.java

@@ -25,7 +25,6 @@ import com.xy.utils.Beans;
 import com.xy.utils.PageBean;
 import com.xy.utils.R;
 import com.xy.vo.SysRoleVo;
-import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
 import lombok.RequiredArgsConstructor;
 import org.springframework.stereotype.Service;
@@ -47,7 +46,7 @@ import static com.xy.utils.PlusBeans.toPageBean;
  * @author 谭斌
  * @date 2022/12/12 17:17
  */
-@Api(tags = "角色管理")
+
 @Service
 @RequiredArgsConstructor
 public class SysRoleServiceImpl extends ServiceImpl<SysRoleMapper, SysRole> implements SysRoleService {

+ 0 - 2
authorize-api-service/src/main/java/com/xy/service/impl/SysSystemServiceImpl.java

@@ -13,7 +13,6 @@ import com.xy.service.SysSystemService;
 import com.xy.utils.MybatisPlusQuery;
 import com.xy.utils.PageBean;
 import com.xy.utils.R;
-import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
 import lombok.AllArgsConstructor;
 import org.springframework.stereotype.Service;
@@ -37,7 +36,6 @@ import static com.xy.utils.PlusBeans.toPageBean;
  * @since 2022-12-09
  */
 @Service
-@Api(tags = "系统接口")
 @AllArgsConstructor
 public class SysSystemServiceImpl extends ServiceImpl<SysSystemMapper, SysSystem> implements SysSystemService {
 

+ 0 - 2
authorize-api-service/src/main/java/com/xy/service/impl/SysSystemValueServiceImpl.java

@@ -11,7 +11,6 @@ import com.xy.service.SysSystemValueService;
 import com.xy.utils.MybatisPlusQuery;
 import com.xy.utils.PageBean;
 import com.xy.utils.R;
-import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
 import org.springframework.stereotype.Service;
 import org.springframework.validation.annotation.Validated;
@@ -32,7 +31,6 @@ import static com.xy.utils.PlusBeans.toPageBean;
  * @since 2022-12-09
  */
 @Service
-@Api(tags = "系统属性接口")
 public class SysSystemValueServiceImpl extends ServiceImpl<SysSystemValueMapper, SysSystemValue> implements SysSystemValueService {
 
     @PostMapping("save")

+ 0 - 9
authorize-api-service/src/main/java/com/xy/service/impl/SysWorkUserServiceImpl.java

@@ -21,8 +21,6 @@ import com.xy.service.SysWorkUserService;
 import com.xy.utils.Beans;
 import com.xy.utils.R;
 import icu.mhb.mybatisplus.plugln.core.JoinLambdaWrapper;
-import io.swagger.annotations.Api;
-import io.swagger.annotations.ApiOperation;
 import lombok.RequiredArgsConstructor;
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Transactional;
@@ -41,7 +39,6 @@ import java.util.stream.Collectors;
  * @author lijin
  * @since 2022-12-09
  */
-@Api(tags = "业务用户管理")
 @RequiredArgsConstructor
 @Service
 public class SysWorkUserServiceImpl extends ServiceImpl<SysWorkUserMapper, SysWorkUser> implements SysWorkUserService {
@@ -60,7 +57,6 @@ public class SysWorkUserServiceImpl extends ServiceImpl<SysWorkUserMapper, SysWo
 
     @Override
     @Transactional(rollbackFor = Exception.class)
-    @ApiOperation(value = "注册", notes = "注册")
     public R<Long> register(AddDto addDto) {
         //校验
         long count = count(new LambdaQueryWrapper<SysWorkUser>()
@@ -97,7 +93,6 @@ public class SysWorkUserServiceImpl extends ServiceImpl<SysWorkUserMapper, SysWo
 
     @Override
     @Transactional(rollbackFor = Exception.class)
-    @ApiOperation(value = "修改", notes = "修改")
     public R<Boolean> update(UpdateDto updateDto) {
         //更新用户信息
         SysWorkUser sysWorkUser = Beans.copy(SysWorkUser.class, updateDto)
@@ -133,7 +128,6 @@ public class SysWorkUserServiceImpl extends ServiceImpl<SysWorkUserMapper, SysWo
 
     @Override
     @Transactional(rollbackFor = Exception.class)
-    @ApiOperation(value = "删除", notes = "删除")
     public R del(DelDto delDto) {
         //删除用户角色
         sysUserRoleMapper.delete(new LambdaQueryWrapper<SysUserRole>().in(SysUserRole::getWorkUserId, delDto.getId()));
@@ -145,7 +139,6 @@ public class SysWorkUserServiceImpl extends ServiceImpl<SysWorkUserMapper, SysWo
     }
 
     @Override
-    @ApiOperation("登录")
     public R<String> login(LoginDto loginDto) {
         SysWorkUser sysWorkUser;
         //手机短信登录
@@ -188,14 +181,12 @@ public class SysWorkUserServiceImpl extends ServiceImpl<SysWorkUserMapper, SysWo
     }
 
     @Override
-    @ApiOperation("登出")
     public R logout() {
         StpUtil.logoutByTokenValue(RedisCache.getToken());
         return R.ok();
     }
 
     @Override
-    @ApiOperation("集合查询")
     public R<List<SysWorkVo>> list(ListDto listDto) {
         //条件构造
         JoinLambdaWrapper<SysWorkUser> joinLambdaWrapper = new JoinLambdaWrapper<>(SysWorkUser.class)

+ 2 - 0
authorize-api/src/main/java/com/xy/service/AuthorizeService.java

@@ -4,6 +4,7 @@ import com.xy.annotate.RestMappingController;
 import com.xy.dto.AuthorizeDto;
 import com.xy.dto.SysMenuDto;
 import com.xy.utils.R;
+import io.swagger.annotations.Api;
 import org.springframework.validation.annotation.Validated;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestBody;
@@ -13,6 +14,7 @@ import java.util.List;
 /**
  * 鉴权相关接口
  */
+@Api(tags = "鉴权相关接口")
 @RestMappingController("authorize")
 public interface AuthorizeService {
 

+ 3 - 1
authorize-api/src/main/java/com/xy/service/CaptchaService.java

@@ -1,12 +1,14 @@
 package com.xy.service;
 
 import com.xy.annotate.RestMappingController;
+import io.swagger.annotations.Api;
 
 /***
  * 验证码服务
  * @author 谭斌
  * @date 2022/12/15 14:05
  */
+@Api(tags = "滑块验证码操作")
 @RestMappingController("xy-captcha")
 public interface CaptchaService {
 
@@ -18,5 +20,5 @@ public interface CaptchaService {
      */
     Boolean reVerification(String captchaVerification);
 
- 
+
 }

+ 2 - 0
authorize-api/src/main/java/com/xy/service/SysDeptService.java

@@ -1,12 +1,14 @@
 package com.xy.service;
 
 import com.xy.annotate.RestMappingController;
+import io.swagger.annotations.Api;
 
 /***
  * 部门管理服务类
  * @author 谭斌
  * @date 2022/12/12 16:37
  */
+@Api(tags = "部门管理")
 @RestMappingController("sysDept")
 public interface SysDeptService {
 

+ 2 - 0
authorize-api/src/main/java/com/xy/service/SysMenuService.java

@@ -1,6 +1,7 @@
 package com.xy.service;
 
 import com.xy.annotate.RestMappingController;
+import io.swagger.annotations.Api;
 
 /**
  * <p>
@@ -10,6 +11,7 @@ import com.xy.annotate.RestMappingController;
  * @author lijin
  * @since 2022-12-09
  */
+@Api(tags = "菜单管理")
 @RestMappingController("sys-menu")
 public interface SysMenuService {
 

+ 2 - 0
authorize-api/src/main/java/com/xy/service/SysRoleService.java

@@ -1,12 +1,14 @@
 package com.xy.service;
 
 import com.xy.annotate.RestMappingController;
+import io.swagger.annotations.Api;
 
 /***
  * 系统角色服务类
  * @author 谭斌
  * @date 2022/12/12 16:37
  */
+@Api(tags = "角色管理")
 @RestMappingController("sysRole")
 public interface SysRoleService {
 

+ 2 - 0
authorize-api/src/main/java/com/xy/service/SysSystemService.java

@@ -1,6 +1,7 @@
 package com.xy.service;
 
 import com.xy.annotate.RestMappingController;
+import io.swagger.annotations.Api;
 
 /**
  * <p>
@@ -10,6 +11,7 @@ import com.xy.annotate.RestMappingController;
  * @author lijin
  * @since 2022-12-09
  */
+@Api(tags = "系统接口")
 @RestMappingController("sys-system")
 public interface SysSystemService {
 

+ 2 - 0
authorize-api/src/main/java/com/xy/service/SysSystemValueService.java

@@ -1,6 +1,7 @@
 package com.xy.service;
 
 import com.xy.annotate.RestMappingController;
+import io.swagger.annotations.Api;
 
 /**
  * <p>
@@ -10,6 +11,7 @@ import com.xy.annotate.RestMappingController;
  * @author lijin
  * @since 2022-12-09
  */
+@Api(tags = "系统属性接口")
 @RestMappingController("sys-system-value")
 public interface SysSystemValueService {
 

+ 2 - 0
authorize-api/src/main/java/com/xy/service/SysWorkUserService.java

@@ -3,6 +3,7 @@ package com.xy.service;
 import com.xy.annotate.RestMappingController;
 import com.xy.dto.SysWorkUser.*;
 import com.xy.utils.R;
+import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
 import org.springframework.validation.annotation.Validated;
 import org.springframework.web.bind.annotation.PostMapping;
@@ -16,6 +17,7 @@ import java.util.List;
  * @author 谭斌
  * @date 2022/12/13 19:06
  */
+@Api(value = "业务用户管理")
 @RestMappingController("sysWorkUser")
 public interface SysWorkUserService {
 

+ 1 - 1
authorize-start/pom.xml

@@ -45,7 +45,7 @@
         <dependency>
             <groupId>cn.torna</groupId>
             <artifactId>swagger-plugin</artifactId>
-            <version>1.2.18</version>
+            <version>2.2.20</version>
         </dependency>
 
     </dependencies>