SpringCloud整合Swagger3

思想

• 将swagger的依赖放到common模块，然后每个服务都配置swagger，相当于单体springboot项目集成swagger，然后在网关层gateway统一集成所有服务的swagger，这样在页面上就能看到所有服务的接口文档了。

步骤

微服务端

引入依赖

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>${swagger.starter.version}</version>
</dependency>

swagger配置属性注入类

package com.lyy.yingwudemo.yingwu_member.configs;

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

/**
 * @author :lyy
 * @date : 04-03-9:30
 */
@Component
@ConfigurationProperties("swagger")
@Data
public class SwaggerProperties {
    /**
     * 是否开启swagger，生产环境一般关闭，所以这里定义一个变量
     */
    private Boolean enable;

    /**
     * 项目应用名
     */
    private String applicationName;

    /**
     * 项目版本信息
     */
    private String applicationVersion;

    /**
     * 项目描述信息
     */
    private String applicationDescription;

    /**
     * 接口调试地址
     */
    private String tryHost;

}

自定义配置

springfox:
  documentation:
    swagger-ui:
      enabled: true # false关闭swagger-ui界面 但不关闭openapi
#    swagger:
#      v3:
#        path: /v3/api-docs
# ===== 自定义swagger配置 ===== #
swagger:
  enable: true
  application-name: ${spring.application.name}
  application-version: 1.0
  application-description: springfox swagger 3.0整合Demo
  try-host: http://localhost:${server.port}

swagger配置类

package com.lyy.yingwudemo.yingwu_member.configs;

import io.swagger.annotations.ApiOperation;
import io.swagger.models.auth.In;
import org.apache.commons.lang.reflect.FieldUtils;
import org.springframework.boot.SpringBootVersion;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.util.ReflectionUtils;
import org.springframework.web.servlet.config.annotation.InterceptorRegistration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.*;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.contexts.SecurityContext;
import springfox.documentation.spring.web.plugins.Docket;

import java.lang.reflect.Field;
import java.util.*;

/**
 * @author :lyy
 * @date : 04-03-0:04
 */
@Configuration
public class SwaggerConfig implements WebMvcConfigurer {
    private final SwaggerProperties swaggerProperties;

    public SwaggerConfig(SwaggerProperties swaggerProperties) {
        this.swaggerProperties = swaggerProperties;
    }
    @Bean
    public Docket createRestApi() {
        //DocumentationType.OAS_30 指的是 openApi 3.0 开放API3.0标准类型
        //Swagger 2与OpenAPI 3 的区别 https://www.jianshu.com/p/879baf1cff07
        // springfox-boot-starter 3.0.0 这个官方提供的swagger推荐使用 OAS_30标准
        // OpenAPI 规范（OAS）定义了一个标准的、语言无关的 RESTful API 接口规范，
        // 它可以同时允许开发人员和操作系统查看并理解某个服务的功能，而无需访问源代码
        // OpenAPI 规范摘要 https://www.jianshu.com/p/5365ef83252a
        return new Docket(DocumentationType.OAS_30).pathMapping("/")

                // 定义是否开启swagger，false为关闭，可以通过变量控制
                .enable(swaggerProperties.getEnable())

                // 将api的元信息设置为包含在json ResourceListing响应中。
                .apiInfo(apiInfo())

                // 接口调试地址
                .host(swaggerProperties.getTryHost())

                // 选择哪些接口作为swagger的doc发布，配合下面的apis使用
                .select()
                // 表示只对类上用@Api注解且方法上用@ApiOpearation才会暴露给swagger
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                // 配置如何通过path过滤,例如PathSelectors.ant("/ali/**")只扫描请求以/ali开头的接口
                .paths(PathSelectors.any())
                .build()
                // 还可以设置分组，@bean注入多个Docket就是多个分组
                .groupName("Default")

                // 支持的通讯协议集合
                .protocols(newHashSet("https", "http"))

                // 授权信息设置，必要的header token等认证信息
                .securitySchemes(securitySchemes())

                // 授权信息全局应用
                .securityContexts(securityContexts());
    }

    /**
     * API 页面上半部分展示信息
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title(swaggerProperties.getApplicationName() + " Api Doc")
                .description(swaggerProperties.getApplicationDescription())
                .contact(new Contact("lyy", null, "[email protected]"))
                .version("Application Version: " + swaggerProperties.getApplicationVersion() + ", Spring Boot Version: " + SpringBootVersion.getVersion())
                .build();
    }

    /**
     * 设置授权信息
     */
    private List<SecurityScheme> securitySchemes() {
        //注意，这里应对应登录token鉴权对应的k-v
        ApiKey apiKey = new ApiKey("BASE_TOKEN", "token", In.HEADER.toValue());//
        return Collections.singletonList(apiKey);
    }

    /**
     * 授权信息全局应用
     */
    private List<SecurityContext> securityContexts() {
        return Collections.singletonList(
                SecurityContext.builder()
                        .securityReferences(defaultAuth())
                        .build()
        );
    }

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

    //设置Swagger3启用JWT的全局认证
    private List<SecurityReference> defaultAuth() {
        List<SecurityReference> result = new ArrayList<>();
        AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
        AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
        authorizationScopes[0] = authorizationScope;
        result.add(new SecurityReference("BASE_TOKEN", authorizationScopes));
        return result;
    }


    /**
     * 通用拦截器排除swagger设置，所有拦截器都会自动加swagger相关的资源排除信息
     */
    @SuppressWarnings("unchecked")
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        try {
            Field registrationsField = FieldUtils.getField(InterceptorRegistry.class, "registrations", true);
            List<InterceptorRegistration> registrations = (List<InterceptorRegistration>) ReflectionUtils.getField(registrationsField, registry);
            if (registrations != null) {
                for (InterceptorRegistration interceptorRegistration : registrations) {
                    interceptorRegistration
                            .excludePathPatterns("/swagger**/**")
                            .excludePathPatterns("/webjars/**")
                            .excludePathPatterns("/v3/**")
                            .excludePathPatterns("/doc.html");
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

}

每个重要的函数的作用：
createRestApi：注入Docket类的Bean，里面就是swagger的基本设置。
securitySchemes：这个函数一旦设置上之后就会在页面上显示一个Authorize图标，如下所示：

然后再执行对应的接口的时候就会要求你输入value，然后在header中携带你写入的value，

这样有什么用呢？可以用来在后台校验合法性。
这个的话涉及Swagger整合JWT的内容，具体可以参考博客：
待补充，如果写完了会在博客中发出来。

网关端

配置路径

spring:
  application:
    name: yingwu_gateway
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848
    gateway:
      routes:
        - id: member_route
          uri: http://localhost:8001
          predicates:
            - Path=/member/**
          filters:
            # 前缀过滤，默认配置下，我们的请求路径是 http://localhost:8888/business-oauth2/** 这时会路由到指定的服务
            # 此处配置去掉 1 个路径前缀，再配置上面的 Path=/api/**，就能按照 http://localhost:8888/api/** 的方式访问了
            - StripPrefix=1 # 剥离路径

        - id: search_route
          uri: http://localhost:8002
          predicates:
            - Path=/search/**
          filters:
            - StripPrefix=1 # 剥离路径

这里有个很有意思的现象，我用nacos配置的，uri如果写lb://+服务名，那么就会报错，报500的错误，报：Internal Server Error http://localhos……的错误，如下图所示

后续解决这个问题。

配置Provider

• 其实就是配置一下让网关的swagger看到所有的服务中的配置就可以了。

package com.lyy.yingwuDemo.yingwu_gateway.config;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.gateway.route.RouteLocator;
import org.springframework.context.annotation.Primary;
import org.springframework.stereotype.Component;
import springfox.documentation.swagger.web.SwaggerResource;
import springfox.documentation.swagger.web.SwaggerResourcesProvider;

import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

/**
 * @author :lyy
 * @date : 04-05-15:10
 */
@Component
@Primary
public class MySwaggerResourcesProvider implements SwaggerResourcesProvider {

    /**
     * swagger3默认的url后缀
     */
    private static final String SWAGGER2URL = "/v3/api-docs";
    /**
     * 网关路由
     */
    private final RouteLocator routeLocator;

    /**
     * 网关应用名称
     */
    @Value("${spring.application.name}")
    private String self;

    @Autowired
    public MySwaggerResourcesProvider(RouteLocator routeLocator) {
        this.routeLocator = routeLocator;
    }

    /**
     * 对于gateway来说这块比较重要 让swagger能找到对应的服务
     *
     * @return
     */
    @Override
    public List<SwaggerResource> get() {
        List<SwaggerResource> resources = new ArrayList<>();
        List<String> routeHosts = new ArrayList<>();
        // 获取所有可用的host：serviceId
        routeLocator.getRoutes().filter(route -> route.getUri().getHost() != null)
                .filter(route -> !self.equals(route.getUri().getHost()))
                .subscribe(route -> routeHosts.add(route.getUri().getHost()));

        // 记录已经添加过的server
        Set<String> dealed = new HashSet<>();
        routeHosts.forEach(instance -> {
            // 拼接url
            String url = "/" + instance.toLowerCase() + SWAGGER2URL;
            if (!dealed.contains(url)) {
                dealed.add(url);
                SwaggerResource swaggerResource = new SwaggerResource();
                swaggerResource.setUrl(url);
                swaggerResource.setName(instance);
                resources.add(swaggerResource);
            }
        });
        return resources;
    }
}

/**
 * 这个类是核心，这个类封装的是SwaggerResource，即在swagger-ui.html页面中顶部的选择框，选择服务的swagger页面内容。
 * RouteLocator：获取spring cloud gateway中注册的路由
 * RouteDefinitionLocator：获取spring cloud gateway路由的详细信息
 * RestTemplate：获取各个配置有swagger的服务的swagger-resources
 */

他其实是这么获取地址的，发送的api-docs的请求路径是这样的：http://gateway的IP地址:端口/注册的对应服务的路由名/v3/api-docs。

效果

我的项目里应用了springsecurity，所以导致每个微服务必须单独登录才能显示doc，否则会显示获取失败，这个问题不大，就是springsecurity这块需要改一下。

第二天更新：这里把security组件从common中抽取出来了，建立一个专门的鉴权微服务，这里问题就解决了~

其他

有几个博客对于本文的参考起到了很大的帮助：
https://blog.csdn.net/tutian2000/article/details/111993949
https://blog.csdn.net/she8292802/article/details/129261830
https://www.kancloud.cn/fymod/backend/1532727
https://blog.csdn.net/JennyTheArtist/article/details/116671042