swagger整合gateway实现文档集中化过程

 更新时间:2026年02月06日 14:59:09   作者:哀愁  
本文介绍了如何将Swagger与Spring Cloud Gateway整合,实现API文档的集中化管理,通过Spring Boot的自动装配,配置了网关Swagger资源提供程序,实现了通过gateway路由的方式聚合Swagger文档,整个过程包括了文件夹结构、自动装配文件内容等详细步骤

swagger整合gateway文档集中化

swagger的公用配置

@ConfigurationProperties("my.swagger")
@Getter
@Setter
public class SwaggerProperties {
    /**
     * swagger2默认的url后缀
     */
    private String swagger2Url = "/v2/api-docs";

    private String oas30Url = "/v3/api-docs";

    private String swaggerVersion = "2.0";


    /**
     * 自动生成文档的路由名称,设置了generateRoutes之后,ignoreRoutes不生效
     */
    private Set<String> generateRoutes = new HashSet<>();

    /**
     * 不自动生成文档的路由名称,设置了generateRoutes之后,本配置不生效
     */
    private Set<String> ignoreRoutes = new HashSet<>();

    /**
     * 是否显示该路由
     */
    public boolean isShow(String route) {
        int generateRoutesSize = generateRoutes.size();
        int ignoreRoutesSize = ignoreRoutes.size();

        if (generateRoutesSize > 0 && !generateRoutes.contains(route)) {
            return false;
        }

        if (ignoreRoutesSize > 0 && ignoreRoutes.contains(route)) {
            return false;
        }

        return true;
    }


}

网关 Swagger 资源提供程序gateway 路由的方式聚合swagger文档

@EnableConfigurationProperties(SwaggerProperties.class)
@Primary
public class GatewaySwaggerResourceProvider implements SwaggerResourcesProvider {
    @Resource
    private SwaggerProperties swaggerProperties;
    private final RouteLocator routeLocator;
    private final GatewayProperties gatewayProperties;

    @Autowired
    public GatewaySwaggerResourceProvider(RouteLocator routeLocator, GatewayProperties gatewayProperties) {
        this.routeLocator = routeLocator;
        this.gatewayProperties = gatewayProperties;
    }

    /**
     * 获取所有的swagger资源配置
     *
     * @return
     */
    @Override
    public List<SwaggerResource> get() {
        List<SwaggerResource> resources = new ArrayList<>();
        Set<String> routes = new HashSet<>();
        //取出Spring Cloud Gateway中的route
        routeLocator.getRoutes().subscribe(route -> routes.add(route.getId()));
        //结合application.yml中的路由配置,只获取有效的route节点
        gatewayProperties.getRoutes().stream().filter(
                routeDefinition -> (
                        routes.contains(routeDefinition.getId()) && swaggerProperties.isShow(routeDefinition.getId())
                )
        ).forEach(routeDefinition -> routeDefinition.getPredicates().stream()
                .filter(predicateDefinition -> ("Path").equalsIgnoreCase(predicateDefinition.getName()))
                .forEach(predicateDefinition -> resources.add(
                        swaggerResource(
                                routeDefinition.getId(),
                                predicateDefinition.getArgs().get(NameUtils.GENERATED_NAME_PREFIX + "0").replace("/**", swaggerProperties.getSwagger2Url())
                        )
                        )
                )
        );
        return resources;


    }

    private SwaggerResource swaggerResource(String name, String location) {
        SwaggerResource swaggerResource = new SwaggerResource();
        swaggerResource.setName(name);
        swaggerResource.setLocation(location);
        swaggerResource.setSwaggerVersion(swaggerProperties.getSwaggerVersion());
        return swaggerResource;
    }
}

这里使用的SpringBoot的自动装配

文件夹的结构为

文件内的内容为

Auto Configure

org.springframework.boot.autoconfigure.EnableAutoConfiguration=
com.mn.swagger.SwaggerProperties,
com.mn.swagger.GatewaySwaggerResourceProvider

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。 

相关文章

  • Java NIO实战之聊天室功能详解

    Java NIO实战之聊天室功能详解

    这篇文章主要介绍了Java NIO实战之聊天室功能,结合实例形式详细分析了java NIO聊天室具体的服务端、客户端相关实现方法与操作注意事项,需要的朋友可以参考下
    2019-11-11
  • 详解spring boot starter redis配置文件

    详解spring boot starter redis配置文件

    spring-boot-starter-Redis主要是通过配置RedisConnectionFactory中的相关参数去实现连接redis service。下面通过本文给大家介绍在spring boot的配置文件中redis的基本配置,需要的的朋友参考下
    2017-07-07
  • Java中解析JSON和生成JSON字符串的全面指南

    Java中解析JSON和生成JSON字符串的全面指南

    在现代 Java 开发中,JSON(JavaScript Object Notation)作为一种轻量级的数据交换格式,广泛应用于前后端交互、配置文件读取以及各类数据存储场景,本文将深入剖析常用库及对应实现方式,助力您轻松驾驭 JSON 数据处理,需要的朋友可以参考下
    2025-03-03
  • Java中String的split切割字符串方法实例及扩展

    Java中String的split切割字符串方法实例及扩展

    最近在项目中遇到一个小问题,一个字符串分割成一个数组,下面这篇文章主要给大家介绍了关于Java中String的split切割字符串方法的相关资料,文中通过图文介绍的非常详细,需要的朋友可以参考下
    2022-06-06
  • Java BIO实现聊天程序

    Java BIO实现聊天程序

    这篇文章主要为大家详细介绍了Java BIO实现聊天程序,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-11-11
  • Java中的transient关键字解析

    Java中的transient关键字解析

    这篇文章主要介绍了Java中的 transient关键字解析,有时候我们的一些敏感信息比如密码并不想序列化传输给对方,这个时候transient关键字就派上用场了,如果一个类的变量加上了transient关键字那么这个字段就不会被序列化,需要的朋友可以参考下
    2023-09-09
  • Java实现打印二叉树所有路径的方法

    Java实现打印二叉树所有路径的方法

    这篇文章主要介绍了Java实现打印二叉树所有路径的方法,涉及java二叉树遍历与运算相关操作技巧,需要的朋友可以参考下
    2018-02-02
  • Springboot 2.x集成kafka 2.2.0的示例代码

    Springboot 2.x集成kafka 2.2.0的示例代码

    kafka近几年更新非常快,也可以看出kafka在企业中是用的频率越来越高。本文主要为大家介绍了Springboot 2.x集成kafka 2.2.0的示例代码,需要的可以参考一下
    2022-04-04
  • Spring实现资源的动态加载和卸载的方法小结

    Spring实现资源的动态加载和卸载的方法小结

    这篇文章主要介绍了Spring实现资源的动态加载和卸载的方法小结,文中通过代码示例讲解的非常详细,对大家的学习或工作有一定的帮助,需要的朋友可以参考下
    2024-06-06
  • RocketMQ的push消费方式实现示例

    RocketMQ的push消费方式实现示例

    这篇文章主要为大家介绍了RocketMQ的push消费方式实现示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪<BR>
    2022-08-08

最新评论