From 0b077806196ceb8a68af93f00880ccc70aee50c2 Mon Sep 17 00:00:00 2001
From: 疯狂的狮子li <15040126243@163.com>
Date: 星期四, 07 七月 2022 18:08:14 +0800
Subject: [PATCH] add 整合 springdoc 移除 knife4j
---
ruoyi-framework/src/main/java/com/ruoyi/framework/config/SwaggerConfig.java | 165 +++++++++---------------------------------------------
1 files changed, 29 insertions(+), 136 deletions(-)
diff --git a/ruoyi-framework/src/main/java/com/ruoyi/framework/config/SwaggerConfig.java b/ruoyi-framework/src/main/java/com/ruoyi/framework/config/SwaggerConfig.java
index 2424981..c677378 100644
--- a/ruoyi-framework/src/main/java/com/ruoyi/framework/config/SwaggerConfig.java
+++ b/ruoyi-framework/src/main/java/com/ruoyi/framework/config/SwaggerConfig.java
@@ -1,33 +1,15 @@
package com.ruoyi.framework.config;
-import cn.dev33.satoken.config.SaTokenConfig;
-import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
-import com.github.xiaoymin.knife4j.spring.extension.OpenApiExtensionResolver;
-import com.ruoyi.common.utils.StringUtils;
-import com.ruoyi.common.utils.spring.SpringUtils;
import com.ruoyi.framework.config.properties.SwaggerProperties;
-import io.swagger.models.auth.In;
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.info.Info;
import lombok.RequiredArgsConstructor;
-import org.springframework.beans.BeansException;
-import org.springframework.beans.factory.config.BeanPostProcessor;
+import org.springdoc.core.SpringDocConfiguration;
+import org.springframework.boot.autoconfigure.AutoConfigureBefore;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
-import org.springframework.util.ReflectionUtils;
-import org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping;
-import springfox.documentation.builders.ApiInfoBuilder;
-import springfox.documentation.builders.PathSelectors;
-import springfox.documentation.builders.RequestHandlerSelectors;
-import springfox.documentation.service.*;
-import springfox.documentation.spi.DocumentationType;
-import springfox.documentation.spi.service.contexts.SecurityContext;
-import springfox.documentation.spring.web.plugins.Docket;
-import springfox.documentation.spring.web.plugins.WebFluxRequestHandlerProvider;
-import springfox.documentation.spring.web.plugins.WebMvcRequestHandlerProvider;
-
-import javax.annotation.PostConstruct;
-import java.lang.reflect.Field;
-import java.util.ArrayList;
-import java.util.List;
/**
* Swagger 鏂囨。閰嶇疆
@@ -36,125 +18,36 @@
*/
@RequiredArgsConstructor
@Configuration
-@EnableKnife4j
+@AutoConfigureBefore(SpringDocConfiguration.class)
+@ConditionalOnProperty(name = "swagger.enabled", havingValue = "true", matchIfMissing = true)
public class SwaggerConfig {
private final SwaggerProperties swaggerProperties;
- private final SaTokenConfig saTokenConfig;
- private final OpenApiExtensionResolver openApiExtensionResolver;
- /**
- * 鐢ㄤ簬閫傞厤springboot 2.6
- */
@Bean
- @SuppressWarnings("all")
- public BeanPostProcessor springfoxHandlerProviderBeanPostProcessor() {
- return new BeanPostProcessor() {
- @Override
- public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
- if (bean instanceof WebMvcRequestHandlerProvider || bean instanceof WebFluxRequestHandlerProvider) {
- customizeSpringfoxHandlerMappings(getHandlerMappings(bean));
- }
- return bean;
- }
+ @ConditionalOnMissingBean(OpenAPI.class)
+ public OpenAPI openApi() {
+ OpenAPI openApi = new OpenAPI();
+ // 鏂囨。鍩烘湰淇℃伅
+ SwaggerProperties.InfoProperties infoProperties = swaggerProperties.getInfo();
+ Info info = convertInfo(infoProperties);
+ openApi.info(info);
+ // 鎵╁睍鏂囨。淇℃伅
+ openApi.externalDocs(swaggerProperties.getExternalDocs());
+ openApi.tags(swaggerProperties.getTags());
+ openApi.paths(swaggerProperties.getPaths());
+ openApi.components(swaggerProperties.getComponents());
- private <T extends RequestMappingInfoHandlerMapping> void customizeSpringfoxHandlerMappings(List<T> mappings) {
- mappings.removeIf(mapping -> mapping.getPatternParser() != null);
- }
-
- private List<RequestMappingInfoHandlerMapping> getHandlerMappings(Object bean) {
- try {
- Field field = ReflectionUtils.findField(bean.getClass(), "handlerMappings");
- field.setAccessible(true);
- return (List<RequestMappingInfoHandlerMapping>) field.get(bean);
- } catch (IllegalArgumentException | IllegalAccessException e) {
- throw new IllegalStateException(e);
- }
- }
- };
+ return openApi;
}
- /**
- * 鍒涘缓API
- */
- @PostConstruct
- public void createRestApi() {
- for (SwaggerProperties.Groups group : swaggerProperties.getGroups()) {
- String basePackage = group.getBasePackage();
- Docket docket = new Docket(DocumentationType.OAS_30)
- .enable(swaggerProperties.getEnabled())
- // 鐢ㄦ潵鍒涘缓璇PI鐨勫熀鏈俊鎭紝灞曠ず鍦ㄦ枃妗ｇ殑椤甸潰涓紙鑷畾涔夊睍绀虹殑淇℃伅锛�
- .apiInfo(apiInfo())
- // 璁剧疆鍝簺鎺ュ彛鏆撮湶缁橲wagger灞曠ず
- .select()
- // 鎵弿鎵�鏈夋湁娉ㄨВ鐨刟pi锛岀敤杩欑鏂瑰紡鏇寸伒娲�
- //.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
- // 鎵弿鎸囧畾鍖呬腑鐨剆wagger娉ㄨВ
- .apis(RequestHandlerSelectors.basePackage(basePackage))
- // 鎵弿鎵�鏈� .apis(RequestHandlerSelectors.any())
- .paths(PathSelectors.any())
- .build()
- .groupName(group.getName())
- // 璁剧疆瀹夊叏妯″紡锛宻wagger鍙互璁剧疆璁块棶token
- .securitySchemes(securitySchemes())
- .securityContexts(securityContexts())
- .extensions(openApiExtensionResolver.buildExtensions(group.getName()))
- .pathMapping(swaggerProperties.getPathMapping());
- String beanName = StringUtils.substringAfterLast(basePackage, ".") + "Docket";
- SpringUtils.registerBean(beanName, docket);
- }
- }
-
- /**
- * 瀹夊叏妯″紡锛岃繖閲屾寚瀹歵oken閫氳繃Authorization澶磋姹傚ご浼犻��
- */
- private List<SecurityScheme> securitySchemes() {
- List<SecurityScheme> apiKeyList = new ArrayList<>();
- String header = saTokenConfig.getTokenName();
- apiKeyList.add(new ApiKey(header, header, In.HEADER.toValue()));
- return apiKeyList;
- }
-
- /**
- * 瀹夊叏涓婁笅鏂�
- */
- private List<SecurityContext> securityContexts() {
- List<SecurityContext> securityContexts = new ArrayList<>();
- securityContexts.add(
- SecurityContext.builder()
- .securityReferences(defaultAuth())
- .operationSelector(o -> o.requestMappingPattern().matches("/.*"))
- .build());
- return securityContexts;
- }
-
- /**
- * 榛樿鐨勫畨鍏ㄤ笂寮曠敤
- */
- private List<SecurityReference> defaultAuth() {
- AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
- AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
- authorizationScopes[0] = authorizationScope;
- List<SecurityReference> securityReferences = new ArrayList<>();
- securityReferences.add(new SecurityReference(saTokenConfig.getTokenName(), authorizationScopes));
- return securityReferences;
- }
-
- /**
- * 娣诲姞鎽樿淇℃伅
- */
- private ApiInfo apiInfo() {
- // 鐢ˋpiInfoBuilder杩涜瀹氬埗
- SwaggerProperties.Contact contact = swaggerProperties.getContact();
- return new ApiInfoBuilder()
- // 璁剧疆鏍囬
- .title(swaggerProperties.getTitle())
- // 鎻忚堪
- .description(swaggerProperties.getDescription())
- // 浣滆�呬俊鎭�
- .contact(new Contact(contact.getName(), contact.getUrl(), contact.getEmail()))
- // 鐗堟湰
- .version(swaggerProperties.getVersion())
- .build();
+ private Info convertInfo(SwaggerProperties.InfoProperties infoProperties) {
+ Info info = new Info();
+ info.setTitle(infoProperties.getTitle());
+ info.setDescription(infoProperties.getDescription());
+ info.setContact(infoProperties.getContact());
+ info.setLicense(infoProperties.getLicense());
+ info.setVersion(infoProperties.getVersion());
+ return info;
}
}
--
Gitblit v1.9.3