SwaggerConfig.java 4.17 KB
package com.infoloop.tianting.config;

import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import com.infoloop.tianting.constant.CommonConstants;
import io.swagger.models.auth.In;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.ApiKey;
import springfox.documentation.service.AuthorizationScope;
import springfox.documentation.service.Contact;
import springfox.documentation.service.SecurityReference;
import springfox.documentation.service.SecurityScheme;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.contexts.SecurityContext;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;

import java.util.Arrays;
import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;

@Configuration
@EnableKnife4j
@EnableSwagger2WebMvc
public class SwaggerConfig {

    public static final String[] SWAGGER_WHITELIST = {
            "/swagger-resources",
            "/swagger-ui/**",
            "/swagger-ui/index.html",
            "/swagger-ui.html",
            "/swagger-ui.html/**",
            "/v2/api-docs",
            "/v3/api-docs",
            "/v3/api-docs/**",
            "/doc.html"
    };

    /*引入Knife4j提供的扩展类*/
//    private final OpenApiExtensionResolver openApiExtensionResolver;

//    @Autowired
//    public SwaggerConfig(OpenApiExtensionResolver openApiExtensionResolver) {
//        this.openApiExtensionResolver = openApiExtensionResolver;
//    }

    @Bean
    public Docket docketApp() {
        final var groupName = "后台接口";
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName(groupName)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.infoloop.tianting.controller").or(RequestHandlerSelectors.basePackage("com.infoloop.tianting.streamController")))
                .paths(PathSelectors.any())
                .build()
                //赋予插件体系
//                .extensions(openApiExtensionResolver.buildExtensions(groupName))
                .protocols(newHashSet("https", "http"))
                .securitySchemes(securitySchemes())
                .securityContexts(securityContexts());
    }

    /**
     * 设置授权信息
     */
    private List<SecurityScheme> securitySchemes() {
        final var apiKey = new ApiKey(CommonConstants.AUTHORIZATION, CommonConstants.AUTHORIZATION, In.HEADER.toValue());
        return Collections.singletonList(apiKey);
    }

    /**
     * 授权信息全局应用
     */
    private List<SecurityContext> securityContexts() {
        return Collections.singletonList(
                SecurityContext.builder()
                        .securityReferences(Collections.singletonList(new SecurityReference(CommonConstants.AUTHORIZATION, new AuthorizationScope[]{new AuthorizationScope("global", "accessEverything")})))
                        //设置需要登录认证的路径,非login开头的都需要Token认证
//                        .forPaths(PathSelectors.regex("^(?!login).*$"))
                        .build()
        );
    }

    @SafeVarargs
    private <T> Set<T> newHashSet(T... ts) {
        if (ts.length > 0) {
            return new LinkedHashSet<>(Arrays.asList(ts));
        }
        return null;
    }

    /**
     * 添加摘要信息
     */
    private ApiInfo apiInfo() {
        // 用ApiInfoBuilder进行定制
        return new ApiInfoBuilder()
                // 设置标题
                .title("灵芝云系统")
                // 描述
                .description("物流商后台项目接口文档")
                // 作者信息
                .contact(new Contact("INFO_LOOP", null, null))
                // 版本
                .version("V1.0")
                .build();
    }

}