springcloud gateway聚合swagger2的方法示例

 更新时间:2019年04月11日 08:54:10   作者:十三  
这篇文章主要介绍了springcloud gateway聚合swagger2的方法示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

问题描述

在搭建分布式应用时,每个应用通过nacos在网关出装配了路由,我们希望网关也可以将所有的应用的swagger界面聚合起来。这样前端开发的时候只需要访问网关的swagger就可以,而不用访问每个应用的swagger。

框架

springcloud+gateway+nacos+swagger

问题分析

swagger页面是一个单页面应用,所有的显示的数据都是通过和springfox.documentation.swagger.web.ApiResponseController进行数据交互,首先通过/swagger-resources获取swagger资源信息,获取的信息格式如下:[{name: "default", url: "/v2/api-docs", swaggerVersion: "2.0", location: "/v2/api-docs"}],其中name代表swagger生成的接口组的组名,如图所示:

url

代表swagger接口组的详细信息可以通过 localhost:8081/v2/api-docs来获取,如下图:


在网关处,如果访问/swagger-resources能够获取到所有应用的swagger的资源信息,那么我们的问题就可以解决了,所以我们需要做的是修改/swagger-resources接口的处理方式,使得这个接口能够按照我们的需求返回swagger资源。

解决方案

我们首先在网关处引入swagger的相关依赖,然后实现一个获取其他应用的swagger资源的组件:

  /**
   * 聚合各个服务的swagger接口
   *
   * @author ksyzz
   * @since <pre>2019/04/09</pre>
   */
  @Component
  public class MySwaggerResourceProvider implements SwaggerResourcesProvider {
  
    /**
     * swagger2默认的url后缀
     */
    private static final String SWAGGER2URL = "/v2/api-docs";
  
    /**
     * 网关路由
     */
    private final RouteLocator routeLocator;
  
    /**
     * 网关应用名称
     */
    @Value("${spring.application.name}")
    private String self;
  
    @Autowired
    public MySwaggerResourceProvider(RouteLocator routeLocator) {
      this.routeLocator = routeLocator;
    }
  
    @Override
    public List<SwaggerResource> get() {
      List<SwaggerResource> resources = new ArrayList<>();
      List<String> routeHosts = new ArrayList<>();
      // 由于我的网关采用的是负载均衡的方式,因此我需要拿到所有应用的serviceId
      // 获取所有可用的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,存在同一个应用注册了多个服务在nacos上
      Set<String> dealed = new HashSet<>();
      routeHosts.forEach(instance -> {
        // 拼接url,样式为/serviceId/v2/api-info,当网关调用这个接口时,会自动通过负载均衡寻找对应的主机
        String url = "/" + instance + SWAGGER2URL;
        if (!dealed.contains(url)) {
          dealed.add(url);
          SwaggerResource swaggerResource = new SwaggerResource();
          swaggerResource.setUrl(url);
          swaggerResource.setName(instance);
          resources.add(swaggerResource);
        }
      });
      return resources;
    }
  }

然后定义一个接口类:

 /**
   * swagger聚合接口,三个接口都是swagger-ui.html需要访问的接口
   *
   * @author ksyzz
   * @since <pre>2019/04/09</pre>
   */
  @RestController
  @RequestMapping("/swagger-resources")
  public class SwaggerResourceController {
    private MySwaggerResourceProvider swaggerResourceProvider;
  
    @Autowired
    public SwaggerResourceController(MySwaggerResourceProvider swaggerResourceProvider) {
      this.swaggerResourceProvider = swaggerResourceProvider;
    }
  
    @RequestMapping(value = "/configuration/security")
    public ResponseEntity<SecurityConfiguration> securityConfiguration() {
      return new ResponseEntity<>(SecurityConfigurationBuilder.builder().build(), HttpStatus.OK);
    }
  
    @RequestMapping(value = "/configuration/ui")
    public ResponseEntity<UiConfiguration> uiConfiguration() {
      return new ResponseEntity<>(UiConfigurationBuilder.builder().build(), HttpStatus.OK);
    }
  
    @RequestMapping
    public ResponseEntity<List<SwaggerResource>> swaggerResources() {
      return new ResponseEntity<>(swaggerResourceProvider.get(), HttpStatus.OK);
    }
  }

然后启动网关,访问 http://网关地址/swagger-ui.html,可以看到


在箭头处,可以切换不同应用的swagger页面。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

相关文章

  • 浅谈JVM垃圾回收之哪些对象可以被回收

    浅谈JVM垃圾回收之哪些对象可以被回收

    这篇文章主要介绍了JVM垃圾回收之哪些对象可以被回收,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-03-03
  • 使用springboot对linux进行操控的方法示例

    使用springboot对linux进行操控的方法示例

    这篇文章主要介绍了使用springboot对linux进行操控的方法示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-11-11
  • SpringBoot集成SwaggerUi以及启动时遇到的错误

    SpringBoot集成SwaggerUi以及启动时遇到的错误

    这篇文章主要介绍了SpringBoot集成SwaggerUi以及启动时遇到的错误,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-06-06
  • 详解Java中Callable和Future的区别

    详解Java中Callable和Future的区别

    这篇文章主要介绍了Java中Callable和Future的区别,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2022-11-11
  • Java的Spring框架中DAO数据访问对象的使用示例

    Java的Spring框架中DAO数据访问对象的使用示例

    这篇文章主要介绍了Java的Spring框架中DAO数据访问对象的使用示例,分为在Spring中DOA与JDBC以及与Hibernate的配合使用两种情况来进行演示,需要的朋友可以参考下
    2016-03-03
  • 从汇编码分析java对象的创建过程(推荐)

    从汇编码分析java对象的创建过程(推荐)

    这篇文章主要介绍了从汇编码分析java对象的创建过程,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-03-03
  • java的引用类型的详细介绍

    java的引用类型的详细介绍

    在java中提供了4个级别的引用:强引用、软引用、弱引用、虚引用。其中强引用FinalReference是default个饰符来修饰,其它3个级别均为public修饰
    2013-10-10
  • SpringBoot+BootStrap多文件上传到本地实例

    SpringBoot+BootStrap多文件上传到本地实例

    这篇文章主要介绍了SpringBoot+BootStrap多文件上传到本地实例,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-03-03
  • selenium+java+chrome环境搭建的方法步骤

    selenium+java+chrome环境搭建的方法步骤

    这篇文章主要介绍了selenium+java+chrome环境搭建的方法步骤,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-07-07
  • SpringMVC整合SSM实现表现层数据封装详解

    SpringMVC整合SSM实现表现层数据封装详解

    这篇文章主要介绍了SpringMVC整合SSM实现表现层数据封装,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习吧
    2022-10-10

最新评论