zuul网关，springsecurity认证中心 和 Swagger2 整合遇到的问题

背景

前后端分离项目，后台有若干个接口，并且已经集成了认证中心，每个接口都实现swagger，现在实现的功能是在一个入口处查看各个子服务的信息。

效果如图所示，网关端口是9999，下面先弄了3个子服务。

 

遇到的问题

1.依赖问题

因为依赖的版本和springboot有冲突，导致swagger一直报错，springboot2X版本和swagger老版本好像有兼容性问题，现在统一引入下面的版本。

<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

2.配置问题

一开始没有配置任何swagger数据，只是启动时加入@EnableSwagger2注解，正常启动，扫描到了接口信息，但无描述文字

然后加入下面的代码，swagger无法扫描出接口信息

@Configuration
@EnableSwagger2
public class Swagger2Configuration {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.xxx"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("api文档")
                .description("api文档")
//                .termsOfServiceUrl("/")
                .version("1.0")
                .build();
    }
}

删除上面的配置文件，改为yml文件配置，不知为何也不管用，接口能显示，但无描述文字

swagger:
  base-package: com.xxx.api.code
  title: app-xxx
  description: '接口文档'
  version: 2.0
  terms-of-service-url: www.xxx.com
  contact:
    name: ''
    email: xxx

最后稍微改了一下配置类方式的代码，结果可以，跟第一步很相似，具体原因也不知道为什么，可能也是和版本换代有关系。

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .pathMapping("/")
                .select() // 选择那些路径和api会生成document
                .apis(RequestHandlerSelectors.any())// 对所有api进行监控
                //不显示错误的接口地址
                .paths(Predicates.not(PathSelectors.regex("/error.*")))//错误路径不监控
                .paths(Predicates.not(PathSelectors.regex("/actuator.*")))//错误路径不监控
                .paths(PathSelectors.regex("/.*"))// 对根下所有路径进行监控
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("接口文档")
                .contact(new Contact("xxx", "", "123"))
                .description("接口文档")
                .termsOfServiceUrl("app-xx")
                .version("2.0")
                .build();
    }
}

 

3.弹窗问题

每次更改swagger配置文件，再访问子服务swagger接口，一直显示下图这个内容，大概意思是说被拦截了，无法访问到，可能和认证有关系。

在认证中心处发现已经对swagger路径进行不拦截，原因是......？这个说明还是对认证服务的结构不太理解

捋一下就是，当前系统的认证是一个常见的jwt方式验证，也就是认证服务是独立，子服务也是独立，登陆时需要访问认证服务，通过验证返回一个装有信息的token（cookie）信息存在客户端，之后就跟认证服务毫无关系了，客户单拿着token去访问子服务，子服务也需要引入springsecurity，然后重写里面的校验，也就是校验token信息来判断当前请求是否登陆过了。

现在被拦截说明是子服务没有处理这块，这块是不需要校验的，所以直接放行，在子服务里加入配置：

@Override
    public void configure(HttpSecurity http) throws Exception {
        //所有请求必须认证通过
        http.authorizeRequests()
                //下边的路径放行
                .antMatchers("/v2/api-docs",//swagger api json
                        "/swagger-resources/configuration/ui",//用来获取支持的动作
                        "/swagger-resources",//用来获取api-docs的URI
                        "/swagger-resources/configuration/security",//安全选项
                        "/swagger-ui.html",
                        "/webjars/**").permitAll()
                .anyRequest().authenticated();

    }

本以为可以了，结果打开以后还是显示弹窗，实在无奈，最后清了一下缓存，可以打开了！

原因是和缓存有关！

 

4.swagger和zuul在网关显示

需要注意的地方是zuul网关的配置，下图这个地方我开始写成了每个子服务注册到eruka的applican名称

 

 

突然想到自服务是引入springsecurity后，通过校验头信息内容来