cn.msuno.swagger.spring.boot.autoconfigure.SwaggerAutoConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of swagger-spring-boot-starter Show documentation
Project for Spring Boot
There is a newer version: 2.5.2
Show newest version
package cn.msuno.swagger.spring.boot.autoconfigure;

import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;

import javax.servlet.ServletContext;

import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.plugin.core.PluginRegistry;

import cn.msuno.swagger.spring.boot.autoconfigure.properties.SwaggerProperties;
import springfox.documentation.PathProvider;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.paths.RelativePathProvider;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.spring.web.readers.operation.OperationParameterReader;

/**
 * 配置swagger必要参数
 *
 * @author msuno
 * @version 1.0.0
 */
@Configuration
@EnableConfigurationProperties(SwaggerProperties.class)
@ComponentScan(basePackages = {
        "cn.msuno.swagger.spring.boot.autoconfigure.plugins",
        "cn.msuno.swagger.spring.boot.autoconfigure.web",
        "cn.msuno.swagger.spring.boot.autoconfigure.configuration"
})
@ConditionalOnClass(value = {PluginRegistry.class, OperationParameterReader.class})
public class SwaggerAutoConfiguration {
    
    private static Logger log = LoggerFactory.getLogger(SwaggerAutoConfiguration.class);
    
    /**
     * 注入默认配置
     */
    @Autowired
    private SwaggerProperties swaggerProperties;
   
    @Autowired
    ServletContext servletContext;
    
    /**
     * 如果用户没有配置Docket，定义一个默认Docket
     * @return Docket.class
     */
    @Bean
    @ConditionalOnMissingBean(name = "docket")
    public Docket createDocket() {
        log.info("auto config swagger");
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder().title(swaggerProperties.getTitle())
                        .description(swaggerProperties.getDescription())
                        .termsOfServiceUrl(swaggerProperties.getTermsOfService())
                        .version(swaggerProperties.getVersion())
                        .contact(swaggerProperties.getContact())
                        .license(swaggerProperties.getLicense())
                        .build())
                .pathProvider(new RelativePathProvider(servletContext){
                    @Override
                    protected String applicationPath() {
                        if (StringUtils.isNotBlank(swaggerProperties.getBasePackage())) {
                            return swaggerProperties.getBasePackage();
                        }
                        return super.applicationPath();
                    }
    
                    @Override
                    protected String getDocumentationPath() {
                        if (StringUtils.isNotBlank(swaggerProperties.getBasePackage())) {
                            return swaggerProperties.getBasePackage();
                        }
                        return super.getDocumentationPath();
                    }
                })
                .select()
                .apis(RequestHandlerSelectors.basePackage(swaggerProperties.getBasePackage()))
                .paths(PathSelectors.any())
                .build();
    }
    
    @Bean
    @ConditionalOnMissingBean(name = "statusCode")
    public Map statusCode() {
        return new HashMap<>();
    }
    
}