mirror of
				https://github.com/dromara/RuoYi-Vue-Plus.git
				synced 2025-11-04 08:13:44 +08:00 
			
		
		
		
	update 重构 将框架内的swagger命名更改为springdoc命名避免误解
This commit is contained in:
		@@ -204,8 +204,13 @@ mybatis-encryptor:
 | 
			
		||||
  publicKey:
 | 
			
		||||
  privateKey:
 | 
			
		||||
 | 
			
		||||
# Swagger配置
 | 
			
		||||
swagger:
 | 
			
		||||
springdoc:
 | 
			
		||||
  api-docs:
 | 
			
		||||
    # 是否开启接口文档
 | 
			
		||||
    enabled: true
 | 
			
		||||
  swagger-ui:
 | 
			
		||||
    # 持久化认证数据
 | 
			
		||||
    persistAuthorization: true
 | 
			
		||||
  info:
 | 
			
		||||
    # 标题
 | 
			
		||||
    title: '标题:${ruoyi.name}多租户管理系统_接口文档'
 | 
			
		||||
@@ -225,14 +230,6 @@ swagger:
 | 
			
		||||
        type: APIKEY
 | 
			
		||||
        in: HEADER
 | 
			
		||||
        name: ${sa-token.token-name}
 | 
			
		||||
 | 
			
		||||
springdoc:
 | 
			
		||||
  api-docs:
 | 
			
		||||
    # 是否开启接口文档
 | 
			
		||||
    enabled: true
 | 
			
		||||
  swagger-ui:
 | 
			
		||||
    # 持久化认证数据
 | 
			
		||||
    persistAuthorization: true
 | 
			
		||||
  #这里定义了两个分组,可定义多个,也可以不定义
 | 
			
		||||
  group-configs:
 | 
			
		||||
    - group: 1.演示模块
 | 
			
		||||
 
 | 
			
		||||
@@ -1,13 +1,13 @@
 | 
			
		||||
package org.dromara.common.doc.config;
 | 
			
		||||
 | 
			
		||||
import org.dromara.common.core.utils.StringUtils;
 | 
			
		||||
import org.dromara.common.doc.config.properties.SwaggerProperties;
 | 
			
		||||
import org.dromara.common.doc.handler.OpenApiHandler;
 | 
			
		||||
import io.swagger.v3.oas.models.OpenAPI;
 | 
			
		||||
import io.swagger.v3.oas.models.Paths;
 | 
			
		||||
import io.swagger.v3.oas.models.info.Info;
 | 
			
		||||
import io.swagger.v3.oas.models.security.SecurityRequirement;
 | 
			
		||||
import lombok.RequiredArgsConstructor;
 | 
			
		||||
import org.dromara.common.core.utils.StringUtils;
 | 
			
		||||
import org.dromara.common.doc.config.properties.SpringDocProperties;
 | 
			
		||||
import org.dromara.common.doc.handler.OpenApiHandler;
 | 
			
		||||
import org.springdoc.core.configuration.SpringDocConfiguration;
 | 
			
		||||
import org.springdoc.core.customizers.OpenApiBuilderCustomizer;
 | 
			
		||||
import org.springdoc.core.customizers.OpenApiCustomizer;
 | 
			
		||||
@@ -36,18 +36,18 @@ import java.util.Set;
 | 
			
		||||
 */
 | 
			
		||||
@RequiredArgsConstructor
 | 
			
		||||
@AutoConfiguration(before = SpringDocConfiguration.class)
 | 
			
		||||
@EnableConfigurationProperties(SwaggerProperties.class)
 | 
			
		||||
@EnableConfigurationProperties(SpringDocProperties.class)
 | 
			
		||||
@ConditionalOnProperty(name = "springdoc.api-docs.enabled", havingValue = "true", matchIfMissing = true)
 | 
			
		||||
public class SwaggerConfig {
 | 
			
		||||
public class SpringDocConfig {
 | 
			
		||||
 | 
			
		||||
    private final ServerProperties serverProperties;
 | 
			
		||||
 | 
			
		||||
    @Bean
 | 
			
		||||
    @ConditionalOnMissingBean(OpenAPI.class)
 | 
			
		||||
    public OpenAPI openApi(SwaggerProperties swaggerProperties) {
 | 
			
		||||
    public OpenAPI openApi(SpringDocProperties swaggerProperties) {
 | 
			
		||||
        OpenAPI openApi = new OpenAPI();
 | 
			
		||||
        // 文档基本信息
 | 
			
		||||
        SwaggerProperties.InfoProperties infoProperties = swaggerProperties.getInfo();
 | 
			
		||||
        SpringDocProperties.InfoProperties infoProperties = swaggerProperties.getInfo();
 | 
			
		||||
        Info info = convertInfo(infoProperties);
 | 
			
		||||
        openApi.info(info);
 | 
			
		||||
        // 扩展文档信息
 | 
			
		||||
@@ -65,7 +65,7 @@ public class SwaggerConfig {
 | 
			
		||||
        return openApi;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private Info convertInfo(SwaggerProperties.InfoProperties infoProperties) {
 | 
			
		||||
    private Info convertInfo(SpringDocProperties.InfoProperties infoProperties) {
 | 
			
		||||
        Info info = new Info();
 | 
			
		||||
        info.setTitle(infoProperties.getTitle());
 | 
			
		||||
        info.setDescription(infoProperties.getDescription());
 | 
			
		||||
@@ -18,8 +18,8 @@ import java.util.List;
 | 
			
		||||
 * @author Lion Li
 | 
			
		||||
 */
 | 
			
		||||
@Data
 | 
			
		||||
@ConfigurationProperties(prefix = "swagger")
 | 
			
		||||
public class SwaggerProperties {
 | 
			
		||||
@ConfigurationProperties(prefix = "springdoc")
 | 
			
		||||
public class SpringDocProperties {
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * 文档基本信息
 | 
			
		||||
@@ -1 +1 @@
 | 
			
		||||
org.dromara.common.doc.config.SwaggerConfig
 | 
			
		||||
org.dromara.common.doc.config.SpringDocConfig
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user