update 优化 自定义 openapi 处理器 彻底实现零注解无入侵生成文档

This commit is contained in:
疯狂的狮子li 2022-07-08 19:17:48 +08:00
parent dd25573ebc
commit 7f04327625
41 changed files with 303 additions and 52 deletions

15
pom.xml
View File

@ -21,7 +21,7 @@
<maven-jar-plugin.version>3.2.2</maven-jar-plugin.version> <maven-jar-plugin.version>3.2.2</maven-jar-plugin.version>
<spring-boot.mybatis>2.2.2</spring-boot.mybatis> <spring-boot.mybatis>2.2.2</spring-boot.mybatis>
<druid.version>1.2.11</druid.version> <druid.version>1.2.11</druid.version>
<knife4j.version>3.0.3</knife4j.version> <springdoc.version>1.6.9</springdoc.version>
<swagger-annotations.version>1.5.22</swagger-annotations.version> <swagger-annotations.version>1.5.22</swagger-annotations.version>
<poi.version>5.2.2</poi.version> <poi.version>5.2.2</poi.version>
<easyexcel.version>3.1.1</easyexcel.version> <easyexcel.version>3.1.1</easyexcel.version>
@ -37,6 +37,7 @@
<dynamic-ds.version>3.5.1</dynamic-ds.version> <dynamic-ds.version>3.5.1</dynamic-ds.version>
<tlog.version>1.4.3</tlog.version> <tlog.version>1.4.3</tlog.version>
<xxl-job.version>2.3.1</xxl-job.version> <xxl-job.version>2.3.1</xxl-job.version>
<lombok.version>1.18.24</lombok.version>
<!-- 统一 guava 版本 解决隐式漏洞问题 --> <!-- 统一 guava 版本 解决隐式漏洞问题 -->
<guava.version>30.0-jre</guava.version> <guava.version>30.0-jre</guava.version>
@ -87,13 +88,19 @@
<dependency> <dependency>
<groupId>org.springdoc</groupId> <groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId> <artifactId>springdoc-openapi-ui</artifactId>
<version>1.6.9</version> <version>${springdoc.version}</version>
</dependency> </dependency>
<dependency> <dependency>
<groupId>org.springdoc</groupId> <groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-javadoc</artifactId> <artifactId>springdoc-openapi-javadoc</artifactId>
<version>1.6.9</version> <version>${springdoc.version}</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>${lombok.version}</version>
</dependency> </dependency>
<dependency> <dependency>
@ -341,7 +348,7 @@
<path> <path>
<groupId>org.projectlombok</groupId> <groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId> <artifactId>lombok</artifactId>
<version>1.18.24</version> <version>${lombok.version}</version>
</path> </path>
<path> <path>
<groupId>org.springframework.boot</groupId> <groupId>org.springframework.boot</groupId>

View File

@ -19,7 +19,6 @@ import com.ruoyi.sms.config.properties.SmsProperties;
import com.ruoyi.sms.core.SmsTemplate; import com.ruoyi.sms.core.SmsTemplate;
import com.ruoyi.sms.entity.SmsResult; import com.ruoyi.sms.entity.SmsResult;
import com.ruoyi.system.service.ISysConfigService; import com.ruoyi.system.service.ISysConfigService;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j; import lombok.extern.slf4j.Slf4j;
import org.springframework.validation.annotation.Validated; import org.springframework.validation.annotation.Validated;
@ -39,7 +38,6 @@ import java.util.Map;
@Anonymous @Anonymous
@Slf4j @Slf4j
@Validated @Validated
@Tag(name = "验证码操作处理", description = "验证码管理")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
public class CaptchaController { public class CaptchaController {

View File

@ -19,7 +19,6 @@ import java.util.*;
* *
* @author Lion Li * @author Lion Li
*/ */
@Tag(name = "缓存监控", description = "缓存监控管理")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
@RequestMapping("/monitor/cache") @RequestMapping("/monitor/cache")

View File

@ -24,7 +24,6 @@ import java.util.List;
* @author Lion Li * @author Lion Li
*/ */
@Validated @Validated
@Tag(name = "系统访问记录", description = "系统访问记录管理")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
@RequestMapping("/monitor/logininfor") @RequestMapping("/monitor/logininfor")

View File

@ -24,7 +24,6 @@ import java.util.List;
* @author Lion Li * @author Lion Li
*/ */
@Validated @Validated
@Tag(name = "操作日志记录", description = "操作日志记录管理")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
@RequestMapping("/monitor/operlog") @RequestMapping("/monitor/operlog")

View File

@ -28,7 +28,6 @@ import java.util.List;
* *
* @author Lion Li * @author Lion Li
*/ */
@Tag(name = "在线用户监控", description = "在线用户监控管理")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
@RequestMapping("/monitor/online") @RequestMapping("/monitor/online")

View File

@ -25,7 +25,6 @@ import java.util.List;
* @author Lion Li * @author Lion Li
*/ */
@Validated @Validated
@Tag(name = "参数配置控制器", description = "参数配置管理")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
@RequestMapping("/system/config") @RequestMapping("/system/config")

View File

@ -26,7 +26,6 @@ import java.util.Map;
* @author Lion Li * @author Lion Li
*/ */
@Validated @Validated
@Tag(name = "部门控制器", description = "部门管理")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
@RequestMapping("/system/dept") @RequestMapping("/system/dept")

View File

@ -12,7 +12,6 @@ import com.ruoyi.common.enums.BusinessType;
import com.ruoyi.common.utils.poi.ExcelUtil; import com.ruoyi.common.utils.poi.ExcelUtil;
import com.ruoyi.system.service.ISysDictDataService; import com.ruoyi.system.service.ISysDictDataService;
import com.ruoyi.system.service.ISysDictTypeService; import com.ruoyi.system.service.ISysDictTypeService;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.validation.annotation.Validated; import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
@ -27,7 +26,6 @@ import java.util.List;
* @author Lion Li * @author Lion Li
*/ */
@Validated @Validated
@Tag(name = "数据字典信息控制器", description = "数据字典信息管理")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
@RequestMapping("/system/dict/data") @RequestMapping("/system/dict/data")

View File

@ -25,7 +25,6 @@ import java.util.List;
* @author Lion Li * @author Lion Li
*/ */
@Validated @Validated
@Tag(name = "数据字典信息控制器", description = "数据字典信息管理")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
@RequestMapping("/system/dict/type") @RequestMapping("/system/dict/type")

View File

@ -12,7 +12,6 @@ import org.springframework.web.bind.annotation.RestController;
* *
* @author Lion Li * @author Lion Li
*/ */
@Tag(name ="首页控制器", description = "首页管理")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
public class SysIndexController { public class SysIndexController {

View File

@ -33,7 +33,6 @@ import java.util.Set;
* @author Lion Li * @author Lion Li
*/ */
@Validated @Validated
@Tag(name = "登录验证控制器", description = "登录验证管理")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
public class SysLoginController { public class SysLoginController {

View File

@ -25,7 +25,6 @@ import java.util.Map;
* @author Lion Li * @author Lion Li
*/ */
@Validated @Validated
@Tag(name = "菜单信息控制器", description = "菜单信息管理")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
@RequestMapping("/system/menu") @RequestMapping("/system/menu")

View File

@ -20,7 +20,6 @@ import org.springframework.web.bind.annotation.*;
* @author Lion Li * @author Lion Li
*/ */
@Validated @Validated
@Tag(name = "公告信息控制器", description = "公告信息管理")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
@RequestMapping("/system/notice") @RequestMapping("/system/notice")

View File

@ -31,7 +31,6 @@ import java.util.Arrays;
* @date 2021-08-13 * @date 2021-08-13
*/ */
@Validated @Validated
@Tag(name = "对象存储配置控制器", description = "对象存储配置管理")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
@RequestMapping("/system/oss/config") @RequestMapping("/system/oss/config")

View File

@ -40,7 +40,6 @@ import java.util.Map;
* @author Lion Li * @author Lion Li
*/ */
@Validated @Validated
@Tag(name = "对象存储控制器", description = "对象存储管理")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
@RequestMapping("/system/oss") @RequestMapping("/system/oss")

View File

@ -11,7 +11,6 @@ import com.ruoyi.common.enums.BusinessType;
import com.ruoyi.common.utils.poi.ExcelUtil; import com.ruoyi.common.utils.poi.ExcelUtil;
import com.ruoyi.system.domain.SysPost; import com.ruoyi.system.domain.SysPost;
import com.ruoyi.system.service.ISysPostService; import com.ruoyi.system.service.ISysPostService;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.validation.annotation.Validated; import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.annotation.*;
@ -25,7 +24,6 @@ import java.util.List;
* @author Lion Li * @author Lion Li
*/ */
@Validated @Validated
@Tag(name ="岗位信息控制器", description = "岗位信息管理")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
@RequestMapping("/system/post") @RequestMapping("/system/post")

View File

@ -31,7 +31,6 @@ import java.util.Map;
* @author Lion Li * @author Lion Li
*/ */
@Validated @Validated
@Tag(name = "个人信息控制器", description = "个人信息管理")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
@RequestMapping("/system/user/profile") @RequestMapping("/system/user/profile")

View File

@ -19,7 +19,6 @@ import org.springframework.web.bind.annotation.RestController;
* @author Lion Li * @author Lion Li
*/ */
@Validated @Validated
@Tag(name = "注册验证控制器", description = "注册验证管理")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
public class SysRegisterController extends BaseController { public class SysRegisterController extends BaseController {

View File

@ -32,7 +32,6 @@ import java.util.List;
* @author Lion Li * @author Lion Li
*/ */
@Validated @Validated
@Tag(name = "角色信息控制器", description = "角色信息管理")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
@RequestMapping("/system/role") @RequestMapping("/system/role")

View File

@ -45,7 +45,6 @@ import java.util.Map;
* @author Lion Li * @author Lion Li
*/ */
@Validated @Validated
@Tag(name = "用户信息控制器", description = "用户信息管理")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
@RequestMapping("/system/user") @RequestMapping("/system/user")

View File

@ -18,7 +18,6 @@ import java.io.File;
* @author Michelle.Chung * @author Michelle.Chung
*/ */
@Validated @Validated
@Tag(name = "邮件发送案例", description = "邮件发送案例")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
@RequestMapping("/demo/mail") @RequestMapping("/demo/mail")

View File

@ -20,7 +20,6 @@ import java.time.Duration;
*/ */
// 类级别 缓存统一配置 // 类级别 缓存统一配置
//@CacheConfig(cacheNames = "redissonCacheMap") //@CacheConfig(cacheNames = "redissonCacheMap")
@Tag(name = "spring-cache 演示案例", description = "spring-cache 演示案例")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
@RequestMapping("/demo/cache") @RequestMapping("/demo/cache")

View File

@ -20,7 +20,6 @@ import java.time.LocalTime;
* *
* @author shenxinquan * @author shenxinquan
*/ */
@Tag(name = "测试分布式锁的样例", description = "测试分布式锁的样例")
@Slf4j @Slf4j
@RestController @RestController
@RequestMapping("/demo/redisLock") @RequestMapping("/demo/redisLock")

View File

@ -13,7 +13,6 @@ import org.springframework.web.bind.annotation.RestController;
* *
* @author Lion Li * @author Lion Li
*/ */
@Tag(name = "Redis发布订阅 演示案例", description = "Redis发布订阅")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
@RequestMapping("/demo/redis/pubsub") @RequestMapping("/demo/redis/pubsub")

View File

@ -15,7 +15,6 @@ import org.springframework.web.bind.annotation.RestController;
* *
* @author Lion Li * @author Lion Li
*/ */
@Tag(name = "测试分布式限流样例", description = "测试分布式限流样例")
@Slf4j @Slf4j
@RestController @RestController
@RequestMapping("/demo/rateLimiter") @RequestMapping("/demo/rateLimiter")

View File

@ -22,7 +22,6 @@ import java.util.Map;
* @version 4.2.0 * @version 4.2.0
*/ */
@Validated @Validated
@Tag(name = "短信演示案例", description = "短信演示案例")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
@RequestMapping("/demo/sms") @RequestMapping("/demo/sms")

View File

@ -14,7 +14,6 @@ import org.springframework.web.multipart.MultipartFile;
* *
* @author Lion Li * @author Lion Li
*/ */
@Tag(name = "演示swagger3控制器", description = "演示swagger3接口")
@RestController @RestController
@RequestMapping("/swagger/demo") @RequestMapping("/swagger/demo")
public class Swagger3DemoController { public class Swagger3DemoController {

View File

@ -5,7 +5,6 @@ import com.ruoyi.common.core.controller.BaseController;
import com.ruoyi.common.core.domain.R; import com.ruoyi.common.core.domain.R;
import com.ruoyi.demo.domain.TestDemo; import com.ruoyi.demo.domain.TestDemo;
import com.ruoyi.demo.mapper.TestDemoMapper; import com.ruoyi.demo.mapper.TestDemoMapper;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.DeleteMapping; import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.PostMapping;
@ -21,7 +20,6 @@ import java.util.List;
* @author Lion Li * @author Lion Li
* @date 2021-05-30 * @date 2021-05-30
*/ */
@Tag(name = "测试批量方法", description = "测试批量方法")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
@RequestMapping("/demo/batch") @RequestMapping("/demo/batch")

View File

@ -41,7 +41,6 @@ import java.util.concurrent.TimeUnit;
* @date 2021-07-26 * @date 2021-07-26
*/ */
@Validated @Validated
@Tag(name = "测试单表控制器", description = "测试单表管理")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
@RequestMapping("/demo/demo") @RequestMapping("/demo/demo")

View File

@ -20,7 +20,6 @@ import java.util.Map;
* *
* @author Lion Li * @author Lion Li
*/ */
@Tag(name = "测试Excel功能", description = "测试Excel功能")
@RestController @RestController
@RequestMapping("/demo/excel") @RequestMapping("/demo/excel")
public class TestExcelController { public class TestExcelController {

View File

@ -20,7 +20,6 @@ import javax.validation.constraints.NotNull;
* @author Lion Li * @author Lion Li
*/ */
@Validated @Validated
@Tag(name = "测试国际化控制器", description = "测试国际化管理")
@RestController @RestController
@RequestMapping("/demo/i18n") @RequestMapping("/demo/i18n")
public class TestI18nController { public class TestI18nController {

View File

@ -4,7 +4,6 @@ import com.ruoyi.common.annotation.Sensitive;
import com.ruoyi.common.core.controller.BaseController; import com.ruoyi.common.core.controller.BaseController;
import com.ruoyi.common.core.domain.R; import com.ruoyi.common.core.domain.R;
import com.ruoyi.common.enums.SensitiveStrategy; import com.ruoyi.common.enums.SensitiveStrategy;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.Data; import lombok.Data;
import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMapping;
@ -20,7 +19,6 @@ import org.springframework.web.bind.annotation.RestController;
* @version 3.6.0 * @version 3.6.0
* @see com.ruoyi.common.core.service.SensitiveService * @see com.ruoyi.common.core.service.SensitiveService
*/ */
@Tag(name = "测试数据脱敏控制器", description = "测试数据脱敏管理")
@RestController @RestController
@RequestMapping("/demo/sensitive") @RequestMapping("/demo/sensitive")
public class TestSensitiveController extends BaseController { public class TestSensitiveController extends BaseController {

View File

@ -31,7 +31,6 @@ import java.util.List;
* @date 2021-07-26 * @date 2021-07-26
*/ */
@Validated @Validated
@Tag(name = "测试树表控制器", description = "测试树表管理")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
@RequestMapping("/demo/tree") @RequestMapping("/demo/tree")

View File

@ -21,7 +21,6 @@ import org.springframework.web.bind.annotation.RestController;
* @version 3.6.0 * @version 3.6.0
*/ */
@Slf4j @Slf4j
@Tag(name = "有界队列 演示案例", description = "有界队列")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
@RequestMapping("/demo/queue/bounded") @RequestMapping("/demo/queue/bounded")

View File

@ -2,7 +2,6 @@ package com.ruoyi.demo.controller.queue;
import com.ruoyi.common.core.domain.R; import com.ruoyi.common.core.domain.R;
import com.ruoyi.common.utils.redis.QueueUtils; import com.ruoyi.common.utils.redis.QueueUtils;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j; import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.GetMapping;
@ -24,7 +23,6 @@ import java.util.concurrent.TimeUnit;
* @version 3.6.0 * @version 3.6.0
*/ */
@Slf4j @Slf4j
@Tag(name = "延迟队列 演示案例", description = "延迟队列")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
@RequestMapping("/demo/queue/delayed") @RequestMapping("/demo/queue/delayed")

View File

@ -3,7 +3,6 @@ package com.ruoyi.demo.controller.queue;
import cn.hutool.core.util.RandomUtil; import cn.hutool.core.util.RandomUtil;
import com.ruoyi.common.core.domain.R; import com.ruoyi.common.core.domain.R;
import com.ruoyi.common.utils.redis.QueueUtils; import com.ruoyi.common.utils.redis.QueueUtils;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j; import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.GetMapping;
@ -22,7 +21,6 @@ import org.springframework.web.bind.annotation.RestController;
* @version 3.6.0 * @version 3.6.0
*/ */
@Slf4j @Slf4j
@Tag(name = "优先队列 演示案例", description = "优先队列")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
@RequestMapping("/demo/queue/priority") @RequestMapping("/demo/queue/priority")

View File

@ -1,11 +1,15 @@
package com.ruoyi.framework.config; package com.ruoyi.framework.config;
import com.ruoyi.framework.config.properties.SwaggerProperties; import com.ruoyi.framework.config.properties.SwaggerProperties;
import com.ruoyi.framework.handler.OpenApiHandler;
import io.swagger.v3.oas.models.OpenAPI; import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info; import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.security.SecurityRequirement; import io.swagger.v3.oas.models.security.SecurityRequirement;
import lombok.RequiredArgsConstructor; import lombok.RequiredArgsConstructor;
import org.springdoc.core.SpringDocConfiguration; import org.springdoc.core.*;
import org.springdoc.core.customizers.OpenApiBuilderCustomizer;
import org.springdoc.core.customizers.ServerBaseUrlCustomizer;
import org.springdoc.core.providers.JavadocProvider;
import org.springframework.boot.autoconfigure.AutoConfigureBefore; import org.springframework.boot.autoconfigure.AutoConfigureBefore;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
@ -14,6 +18,7 @@ import org.springframework.context.annotation.Configuration;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List; import java.util.List;
import java.util.Optional;
/** /**
* Swagger 文档配置 * Swagger 文档配置
@ -57,4 +62,17 @@ public class SwaggerConfig {
info.setVersion(infoProperties.getVersion()); info.setVersion(infoProperties.getVersion());
return info; return info;
} }
/**
* 自定义 openapi 处理器
*/
@Bean
public OpenAPIService openApiBuilder(Optional<OpenAPI> openAPI,
SecurityService securityParser,
SpringDocConfigProperties springDocConfigProperties, PropertyResolverUtils propertyResolverUtils,
Optional<List<OpenApiBuilderCustomizer>> openApiBuilderCustomisers,
Optional<List<ServerBaseUrlCustomizer>> serverBaseUrlCustomisers, Optional<JavadocProvider> javadocProvider) {
return new OpenApiHandler(openAPI, securityParser, springDocConfigProperties, propertyResolverUtils, openApiBuilderCustomisers, serverBaseUrlCustomisers, javadocProvider);
}
} }

View File

@ -0,0 +1,272 @@
package com.ruoyi.framework.handler;
import cn.hutool.core.io.IoUtil;
import io.swagger.v3.core.jackson.TypeNameResolver;
import io.swagger.v3.core.util.AnnotationsUtils;
import io.swagger.v3.oas.annotations.tags.Tags;
import io.swagger.v3.oas.models.Components;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.Operation;
import io.swagger.v3.oas.models.Paths;
import io.swagger.v3.oas.models.tags.Tag;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springdoc.core.OpenAPIService;
import org.springdoc.core.PropertyResolverUtils;
import org.springdoc.core.SecurityService;
import org.springdoc.core.SpringDocConfigProperties;
import org.springdoc.core.customizers.OpenApiBuilderCustomizer;
import org.springdoc.core.customizers.ServerBaseUrlCustomizer;
import org.springdoc.core.providers.JavadocProvider;
import org.springframework.context.ApplicationContext;
import org.springframework.core.annotation.AnnotatedElementUtils;
import org.springframework.util.CollectionUtils;
import org.springframework.web.method.HandlerMethod;
import java.io.StringReader;
import java.lang.reflect.Method;
import java.util.*;
import java.util.stream.Collectors;
import java.util.stream.Stream;
/**
* 自定义 openapi 处理器
* 对源码功能进行修改 增强使用
*/
@SuppressWarnings("all")
public class OpenApiHandler extends OpenAPIService {
/**
* The constant LOGGER.
*/
private static final Logger LOGGER = LoggerFactory.getLogger(OpenAPIService.class);
/**
* The Context.
*/
private ApplicationContext context;
/**
* The Security parser.
*/
private final SecurityService securityParser;
/**
* The Mappings map.
*/
private final Map<String, Object> mappingsMap = new HashMap<>();
/**
* The Springdoc tags.
*/
private final Map<HandlerMethod, io.swagger.v3.oas.models.tags.Tag> springdocTags = new HashMap<>();
/**
* The Open api builder customisers.
*/
private final Optional<List<OpenApiBuilderCustomizer>> openApiBuilderCustomisers;
/**
* The server base URL customisers.
*/
private final Optional<List<ServerBaseUrlCustomizer>> serverBaseUrlCustomizers;
/**
* The Spring doc config properties.
*/
private final SpringDocConfigProperties springDocConfigProperties;
/**
* The Open api.
*/
private OpenAPI openAPI;
/**
* The Cached open api map.
*/
private final Map<String, OpenAPI> cachedOpenAPI = new HashMap<>();
/**
* The Is servers present.
*/
private boolean isServersPresent;
/**
* The Server base url.
*/
private String serverBaseUrl;
/**
* The Property resolver utils.
*/
private final PropertyResolverUtils propertyResolverUtils;
/**
* The javadoc provider.
*/
private final Optional<JavadocProvider> javadocProvider;
/**
* The Basic error controller.
*/
private static Class<?> basicErrorController;
static {
try {
//spring-boot 2
basicErrorController = Class.forName("org.springframework.boot.autoconfigure.web.servlet.error.BasicErrorController");
} catch (ClassNotFoundException e) {
//spring-boot 1
try {
basicErrorController = Class.forName("org.springframework.boot.autoconfigure.web.BasicErrorController");
} catch (ClassNotFoundException classNotFoundException) {
//Basic error controller class not found
LOGGER.trace(classNotFoundException.getMessage());
}
}
}
/**
* Instantiates a new Open api builder.
*
* @param openAPI the open api
* @param securityParser the security parser
* @param springDocConfigProperties the spring doc config properties
* @param propertyResolverUtils the property resolver utils
* @param openApiBuilderCustomizers the open api builder customisers
* @param serverBaseUrlCustomizers the server base url customizers
* @param javadocProvider the javadoc provider
*/
public OpenApiHandler(Optional<OpenAPI> openAPI, SecurityService securityParser,
SpringDocConfigProperties springDocConfigProperties, PropertyResolverUtils propertyResolverUtils,
Optional<List<OpenApiBuilderCustomizer>> openApiBuilderCustomizers,
Optional<List<ServerBaseUrlCustomizer>> serverBaseUrlCustomizers,
Optional<JavadocProvider> javadocProvider) {
super(openAPI, securityParser, springDocConfigProperties, propertyResolverUtils, openApiBuilderCustomizers, serverBaseUrlCustomizers, javadocProvider);
if (openAPI.isPresent()) {
this.openAPI = openAPI.get();
if (this.openAPI.getComponents() == null)
this.openAPI.setComponents(new Components());
if (this.openAPI.getPaths() == null)
this.openAPI.setPaths(new Paths());
if (!CollectionUtils.isEmpty(this.openAPI.getServers()))
this.isServersPresent = true;
}
this.propertyResolverUtils = propertyResolverUtils;
this.securityParser = securityParser;
this.springDocConfigProperties = springDocConfigProperties;
this.openApiBuilderCustomisers = openApiBuilderCustomizers;
this.serverBaseUrlCustomizers = serverBaseUrlCustomizers;
this.javadocProvider = javadocProvider;
if (springDocConfigProperties.isUseFqn())
TypeNameResolver.std.setUseFqn(true);
}
@Override
public Operation buildTags(HandlerMethod handlerMethod, Operation operation, OpenAPI openAPI, Locale locale) {
Set<Tag> tags = new HashSet<>();
Set<String> tagsStr = new HashSet<>();
buildTagsFromMethod(handlerMethod.getMethod(), tags, tagsStr, locale);
buildTagsFromClass(handlerMethod.getBeanType(), tags, tagsStr, locale);
if (!CollectionUtils.isEmpty(tagsStr))
tagsStr = tagsStr.stream()
.map(str -> propertyResolverUtils.resolve(str, locale))
.collect(Collectors.toSet());
if (springdocTags.containsKey(handlerMethod)) {
io.swagger.v3.oas.models.tags.Tag tag = springdocTags.get(handlerMethod);
tagsStr.add(tag.getName());
if (openAPI.getTags() == null || !openAPI.getTags().contains(tag)) {
openAPI.addTagsItem(tag);
}
}
if (!CollectionUtils.isEmpty(tagsStr)) {
if (CollectionUtils.isEmpty(operation.getTags()))
operation.setTags(new ArrayList<>(tagsStr));
else {
Set<String> operationTagsSet = new HashSet<>(operation.getTags());
operationTagsSet.addAll(tagsStr);
operation.getTags().clear();
operation.getTags().addAll(operationTagsSet);
}
}
if (isAutoTagClasses(operation)) {
if (javadocProvider.isPresent()) {
String description = javadocProvider.get().getClassJavadoc(handlerMethod.getBeanType());
if (StringUtils.isNotBlank(description)) {
io.swagger.v3.oas.models.tags.Tag tag = new io.swagger.v3.oas.models.tags.Tag();
// 自定义部分 修改使用java注释当tag名
List<String> list = IoUtil.readLines(new StringReader(description), new ArrayList<>());
// tag.setName(tagAutoName);
tag.setName(list.get(0));
operation.addTagsItem(list.get(0));
tag.setDescription(description);
if (openAPI.getTags() == null || !openAPI.getTags().contains(tag)) {
openAPI.addTagsItem(tag);
}
}
} else {
String tagAutoName = splitCamelCase(handlerMethod.getBeanType().getSimpleName());
operation.addTagsItem(tagAutoName);
}
}
if (!CollectionUtils.isEmpty(tags)) {
// Existing tags
List<io.swagger.v3.oas.models.tags.Tag> openApiTags = openAPI.getTags();
if (!CollectionUtils.isEmpty(openApiTags))
tags.addAll(openApiTags);
openAPI.setTags(new ArrayList<>(tags));
}
// Handle SecurityRequirement at operation level
io.swagger.v3.oas.annotations.security.SecurityRequirement[] securityRequirements = securityParser
.getSecurityRequirements(handlerMethod);
if (securityRequirements != null) {
if (securityRequirements.length == 0)
operation.setSecurity(Collections.emptyList());
else
securityParser.buildSecurityRequirement(securityRequirements, operation);
}
return operation;
}
private void buildTagsFromMethod(Method method, Set<io.swagger.v3.oas.models.tags.Tag> tags, Set<String> tagsStr, Locale locale) {
// method tags
Set<Tags> tagsSet = AnnotatedElementUtils
.findAllMergedAnnotations(method, Tags.class);
Set<io.swagger.v3.oas.annotations.tags.Tag> methodTags = tagsSet.stream()
.flatMap(x -> Stream.of(x.value())).collect(Collectors.toSet());
methodTags.addAll(AnnotatedElementUtils.findAllMergedAnnotations(method, io.swagger.v3.oas.annotations.tags.Tag.class));
if (!CollectionUtils.isEmpty(methodTags)) {
tagsStr.addAll(methodTags.stream().map(tag -> propertyResolverUtils.resolve(tag.name(), locale)).collect(Collectors.toSet()));
List<io.swagger.v3.oas.annotations.tags.Tag> allTags = new ArrayList<>(methodTags);
addTags(allTags, tags, locale);
}
}
private void addTags(List<io.swagger.v3.oas.annotations.tags.Tag> sourceTags, Set<io.swagger.v3.oas.models.tags.Tag> tags, Locale locale) {
Optional<Set<io.swagger.v3.oas.models.tags.Tag>> optionalTagSet = AnnotationsUtils
.getTags(sourceTags.toArray(new io.swagger.v3.oas.annotations.tags.Tag[0]), true);
optionalTagSet.ifPresent(tagsSet -> {
tagsSet.forEach(tag -> {
tag.name(propertyResolverUtils.resolve(tag.getName(), locale));
tag.description(propertyResolverUtils.resolve(tag.getDescription(), locale));
if (tags.stream().noneMatch(t -> t.getName().equals(tag.getName())))
tags.add(tag);
});
});
}
}

View File

@ -29,7 +29,6 @@ import java.util.Map;
* @author Lion Li * @author Lion Li
*/ */
@Validated @Validated
@Tag(name = "代码生成", description = "代码生成管理")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
@RequestMapping("/tool/gen") @RequestMapping("/tool/gen")

View File

@ -27,16 +27,14 @@ import ${packageName}.service.I${ClassName}Service;
import com.ruoyi.common.core.page.TableDataInfo; import com.ruoyi.common.core.page.TableDataInfo;
#elseif($table.tree) #elseif($table.tree)
#end #end
import io.swagger.v3.oas.annotations.tags.Tag;
/** /**
* ${functionName}Controller * ${functionName}
* *
* @author ${author} * @author ${author}
* @date ${datetime} * @date ${datetime}
*/ */
@Validated @Validated
@Tag(name ="${functionName}控制器", description = "${functionName}管理")
@RequiredArgsConstructor @RequiredArgsConstructor
@RestController @RestController
@RequestMapping("/${moduleName}/${businessName}") @RequestMapping("/${moduleName}/${businessName}")