好得很程序员自学网

<tfoot draggable='sEl'></tfoot>

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资源的组件:

?

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

/**

  * 聚合各个服务的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;

   }

}

然后定义一个接口类:

?

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

/**

   * 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页面。

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

原文链接:https://segmentfault测试数据/a/1190000018825356

查看更多关于springcloud gateway聚合swagger2的方法示例的详细内容...

  阅读:11次