配置 Swagger 帶 token 訪問的兩種方式

推薦使用全局的方式

1. 每個接口單獨傳

import com.google.common.collect.Lists;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
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.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.List;

/**
 * @Description: swagger配置類
 * @author: Gao Hang Hang
 * @date 2019/01/14 18:42
 */
@Configuration
@EnableSwagger2
@EnableWebMvc
public class SwaggerConfig {

    public static final String AUTHORIZATION_HEADER = "Access-Token";
    public static final String DEFAULT_INCLUDE_PATTERN = "/api/.*";


    /**
     * TODO
     * 可以根據配置讀取是否開啓swagger文檔，針對測試與生產環境採用不同的配置
     */
    private boolean isSwaggerEnable = true;

    //是否開啓swagger，正式環境一般是需要關閉的，可根據springboot的多環境配置進行設置
    @Value(value = "${swagger.enabled}")
    Boolean swaggerEnabled;

    @Bean
    public Docket createRestApi() {
        ParameterBuilder ticketPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<Parameter>();
        ticketPar.name(AUTHORIZATION_HEADER).description("user ticket")//Token 以及Authorization 爲自定義的參數，session保存的名字是哪個就可以寫成那個
                .modelRef(new ModelRef("string")).parameterType("header")
                .required(false).build(); //header中的ticket參數非必填，傳空也可以
        pars.add(ticketPar.build());    //根據每個方法名也知道當前方法在設置什麼參數

        return new Docket(DocumentationType.SWAGGER_2)
                //.groupName("group")
                .enable(swaggerEnabled)
                .apiInfo(apiInfo()).select()
                // 對所有該包下的Api進行監控，如果想要監控所有的話可以改成any()
                //.apis(RequestHandlerSelectors.basePackage("com.iscas"))
                .apis(RequestHandlerSelectors.any())
                // 對所有路徑進行掃描
                .paths(PathSelectors.any())
                .build()
                .globalOperationParameters(pars);
    }

    /**
     * @return 生成文檔說明信息
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("XXXX系統")
                .description("描述")
                //.termsOfServiceUrl("http://gaohanghang.github.io")
                .license("Apache 2.0")
                .licenseUrl("http://www.apache.org/licenses/LICENSE-2.0")
                .version("2.0.0").build();
    }

}

效果：

2. 全局Token

import com.google.common.collect.Lists;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
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.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.List;

/**
 * @Description: swagger配置類
 * @author: Gao Hang Hang
 * @date 2019/01/14 18:42
 */
@Configuration
@EnableSwagger2
@EnableWebMvc
public class SwaggerConfig {

    public static final String AUTHORIZATION_HEADER = "Access-Token";
    public static final String DEFAULT_INCLUDE_PATTERN = "/api/.*";


    /**
     * TODO
     * 可以根據配置讀取是否開啓swagger文檔，針對測試與生產環境採用不同的配置
     */
    private boolean isSwaggerEnable = true;

    //是否開啓swagger，正式環境一般是需要關閉的，可根據springboot的多環境配置進行設置
    @Value(value = "${swagger.enabled}")
    Boolean swaggerEnabled;

    @Bean
    public Docket createRestApi() {
        ParameterBuilder ticketPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<Parameter>();
        ticketPar.name(AUTHORIZATION_HEADER).description("user ticket")//Token 以及Authorization 爲自定義的參數，session保存的名字是哪個就可以寫成那個
                .modelRef(new ModelRef("string")).parameterType("header")
                .required(false).build(); //header中的ticket參數非必填，傳空也可以
        pars.add(ticketPar.build());    //根據每個方法名也知道當前方法在設置什麼參數

        return new Docket(DocumentationType.SWAGGER_2)
                //.groupName("group")
                .enable(swaggerEnabled)
                .apiInfo(apiInfo()).select()
                // 對所有該包下的Api進行監控，如果想要監控所有的話可以改成any()
                //.apis(RequestHandlerSelectors.basePackage("com.iscas"))
                .apis(RequestHandlerSelectors.any())
                // 對所有路徑進行掃描
                .paths(PathSelectors.any())
                .build()
                //.globalOperationParameters(pars);
                .securityContexts(Lists.newArrayList(securityContext()))
                .securitySchemes(Lists.newArrayList(apiKey()));
    }

    private ApiKey apiKey() {
        return new ApiKey(AUTHORIZATION_HEADER , AUTHORIZATION_HEADER, "header");
    }

    private SecurityContext securityContext() {
        return SecurityContext.builder()
                .securityReferences(defaultAuth())
                //.forPaths(PathSelectors.regex(DEFAULT_INCLUDE_PATTERN))
                .forPaths(PathSelectors.regex("^(?!auth).*$"))
                .build();
    }

    List<SecurityReference> defaultAuth() {
        AuthorizationScope authorizationScope
                = new AuthorizationScope("global", "accessEverything");
        AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
        authorizationScopes[0] = authorizationScope;
        return Lists.newArrayList(
                new SecurityReference(AUTHORIZATION_HEADER, authorizationScopes));
    }

    /**
     * @return 生成文檔說明信息
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("XXXX系統")
                .description("描述")
                //.termsOfServiceUrl("http://gaohanghang.github.io")
                .license("Apache 2.0")
                .licenseUrl("http://www.apache.org/licenses/LICENSE-2.0")
                .version("2.0.0").build();
    }

}