swagger页面直接添加token+网关验证

swagger页面直接添加token

概述

最近项目看到swagger.config是像下面这样配置的，然后进去页面右上角有个authoritation，访问接口需要把token传进去。

package com.gsafety.homeCharge.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.RestController;
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.SecurityReference;
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;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
  @Bean
  public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
            .enable(true)
            .apiInfo(apiInfo())
            .useDefaultResponseMessages(false)
            .select()
            .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
            .build()
            .securitySchemes(securitySchemes())
            .securityContexts(securityContexts());
  }


  private List<ApiKey> securitySchemes() {
    List<ApiKey> apiKeyList= new ArrayList<>();
    apiKeyList.add(new ApiKey("token", "token", "header"));
    return apiKeyList;
  }

  private List<SecurityContext> securityContexts() {
    List<SecurityContext> securityContexts=new ArrayList<>();
    securityContexts.add(
            SecurityContext.builder()
                    .securityReferences(defaultAuth())
                    .forPaths(PathSelectors.regex("^(?!auth).*$"))
                    .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("token", authorizationScopes));
    return securityReferences;
  }

  private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            .title("")//大标题
            .version("1.0")//版本
            .build();
  }

}

如何配置：

其实上述代码就可以完成了，关键就是private List securitySchemes()

​ 和private List defaultAuth()

两个方法，想要复用的可以直接ctrl+CV啥都不用改

配置完之后，进去swagger页面然后，填写完token之后，该swagger页面所有的接口的请求头里面都会加上token:“xxxxxxxx”。

加上之后

• 假如你是本地服务启动的话，并且没写拦截器或者过滤器验证token的话，随便填写个token就行
• 假如编写了拦截器或者过滤器，或者该请求要走网关的时候，就需要获取到正确的token才行。