Zuul整合Swagger2与swagger-bootstrap-ui

最新推荐文章于 2024-04-11 14:47:40 发布
最新推荐文章于 2024-04-11 14:47:40 发布
阅读量525 收藏 2
点赞数 1
分类专栏： SpringCloud java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/tzhongwen/article/details/106466146
版权

一、项目情况
1、Eureka项目:shop-eurake
1.1 启动类

@SpringBootApplication
@EnableEurekaServer
public class ShopEurekaApplication {
	public static void main(String[] args) {
		SpringApplication.run(ShopEurekaApplication.class, args);
	}
}

1.2 资源文件

server.port=8000
spring.application.name=shop-eureka

2、Zuul项目：shop-gateway
2.1 启动类

@SpringBootApplication
@EnableZuulProxy
@EnableEurekaClient
public class ShopGatewayApplication {
	public static void main(String[] args) {
		SpringApplication.run(ShopGatewayApplication.class, args);
	}
}

2.2 pom文件，需要添加swagger2相关包

<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>
<dependency>
	<groupId>com.github.xiaoymin</groupId>
	<artifactId>swagger-bootstrap-ui</artifactId>
	<version>1.9.2</version>
</dependency>
<dependency>
	<groupId>com.google.guava</groupId>
	<artifactId>guava</artifactId>
	<version>20.0</version>
</dependency>

2.3 配置文件GatewaySwaggerResourcesProvider

import java.util.ArrayList;
import java.util.List;
import org.springframework.cloud.netflix.zuul.filters.Route;
import org.springframework.cloud.netflix.zuul.filters.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 springfox.documentation.swagger2.annotations.EnableSwagger2;

@Component
@Primary
@EnableSwagger2
public class GatewaySwaggerResourcesProvider implements SwaggerResourcesProvider {
    private final RouteLocator routeLocator;
    public GatewaySwaggerResourcesProvider(RouteLocator routeLocator) {
        this.routeLocator = routeLocator;
    }

    @Override
    public List<SwaggerResource> get() {
        List<SwaggerResource> resources = new ArrayList<>();
        List<Route> routes = routeLocator.getRoutes();
        for (Route route:routes) {
        	resources.add(swaggerResource(route.getId(), route.getFullPath().replace("**", "v2/api-docs"),"2.0"));
        }
        return resources;
    }
    
    private SwaggerResource swaggerResource(String name, String location, String version) {
        SwaggerResource swaggerResource = new SwaggerResource();
        swaggerResource.setName(name);
        swaggerResource.setLocation(location);
        swaggerResource.setSwaggerVersion(version);
        return swaggerResource;
    }
}

2.4 配置文件WebMvcConfig

import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;

import springfox.documentation.spring.web.SpringfoxWebMvcConfiguration;

@SpringBootApplication
@ConditionalOnClass(SpringfoxWebMvcConfiguration.class)
public class WebMvcConfig extends  WebMvcConfigurationSupport{
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");//doc.html是文档的访问路径，可以自己更改
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
}

2.5 资料文件

server.port=8001
spring.application.name=shop-gateway
eureka.client.serviceUrl.defaultZone=http://localhost:8000/eureka/

3、业务项目1：shop-business

3.1 pom依赖,不需要swaggerUI

<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-swagger2</artifactId>
	<version>2.9.2</version>
</dependency>
<dependency>
	<groupId>com.google.guava</groupId>
	<artifactId>guava</artifactId>
</dependency>

3.2 启动类

@SpringBootApplication
@EnableEurekaClient
public class ShopBusinessApplication {
	public static void main(String[] args) {
		SpringApplication.run(ShopBusinessApplication.class, args);
	}

}

3.3 Swagger配置文件Swagger2,注意basePackage是你的controller的包目录不能错

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

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("购物车-业务模块")//项目模块描述
                .description("slan")
                .version("1.0")
                .build();
    }
}

3.4 资源文件

server.port=8013
spring.application.name=shop-business
eureka.client.serviceUrl.defaultZone=http://127.0.0.1:8000/eureka/

3.5 需要展示的接口类OrderController

@RestController
public class OrderController {
	@ApiOperation(value = "商品详情", httpMethod = "GET")
	@RequestMapping(value="/get/{id}", method = RequestMethod.GET)
	public String get(@PathVariable String id) {
		try {
			System.out.println(LocalTime.now());
		} catch (Exception e) {
			e.printStackTrace();
		}
		return id+"";
	}
}

4、业务项目2：shop-user-center

4.1 pom依赖,不需要swaggerUI

<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-swagger2</artifactId>
	<version>2.9.2</version>
</dependency>
<dependency>
	<groupId>com.google.guava</groupId>
	<artifactId>guava</artifactId>
</dependency>

4.2 启动类

@SpringBootApplication
@EnableEurekaClient
public class ShopUserCenterApplication {
	public static void main(String[] args) {
		SpringApplication.run(ShopUserCenterApplication.class, args);
	}
}

4.3 Swagger配置文件Swagger2,注意basePackage是你的controller的包目录不能错

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

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("购物车 -用户模块AIP")//项目模块描述
                .description("slan")
                .version("1.0")
                .build();
    }
}

4.4 资源文件

server.port=8002
spring.application.name=shop-user-center
eureka.client.serviceUrl.defaultZone=http://127.0.0.1:8000/eureka/

4.5 需要展示的接口类OrderController

@Api(value = "用户信息管理")
@RestController
public class UserController {
	@ApiOperation(value = "获取用户详细信息", notes="获取用户详细信息")
	@ApiImplicitParam(name = "id", value = "用户ID", paramType = "path", required = true, dataType = "Integer")
	@RequestMapping(value = "/get/{id}" ,method = RequestMethod.GET)
	public String getUser(@PathVariable Integer id) {
		try {
			System.out.println(LocalTime.now());
		} catch (InterruptedException e) {
			e.printStackTrace();
		}
		return id+"";
	}
}

二、测试情况
1.访问路径
http://ip:网关端口/WebMvcConfig类中的addResourceHandler(“doc.html”)，
如：http://localhost:8001/doc.html

2.测试效果
image.png
image.png

3.通过上图可以发现所有注册到eureka的服务都被加入进来了，不需要每个服务都要配置swaggerui,也不需要到处找接口文档了。
4.通过swaggerui上可以直接复制markdown格式文件。

三、总结
1.注意com.google.guava包版本问题，如果版本过低会报异常：


org.springframework.context.ApplicationContextException: Failed to start bean 'documentationPluginsBootstrapper'; nested exception is com.google.common.util.concurrent.ExecutionError: java.lang.NoSuchMethodError: com.google.common.collect.FluentIterable.concat(Ljava/lang/Iterable;Ljava/lang/Iterable;)Lcom/google/common/collect/FluentIterable;
	at org.springframework.context.support.DefaultLifecycleProcessor.doStart(DefaultLifecycleProcessor.java:178) ~[spring-context-4.3.9.RELEASE.jar:4.3.9.RELEASE]
	at org.springframework.context.support.DefaultLifecycleProcessor.access$200(DefaultLifecycleProcessor.java:50) ~[spring-context-4.3.9.RELEASE.jar:4.3.9.RELEASE]
	at org.springframework.context.support.DefaultLifecycleProcessor$LifecycleGroup.start(DefaultLifecycleProcessor.java:348) ~[spring-context-4.3.9.RELEASE.jar:4.3.9.RELEASE]
	at org.springframework.context.support.DefaultLifecycleProcessor.startBeans(DefaultLifecycleProcessor.java:151) ~[spring-context-4.3.9.RELEASE.jar:4.3.9.RELEASE]
	at org.springframework.context.support.DefaultLifecycleProcessor.onRefresh(DefaultLifecycleProcessor.java:114) ~[spring-context-4.3.9.RELEASE.jar:4.3.9.RELEASE]
	at org.springframework.context.support.AbstractApplicationContext.finishRefresh(AbstractApplicationContext.java:880) ~[spring-context-4.3.9.RELEASE.jar:4.3.9.RELEASE]
	at org.springframework.boot.context.embedded.EmbeddedWebApplicationContext.finishRefresh(EmbeddedWebApplicationContext.java:144) ~[spring-boot-1.4.7.RELEASE.jar:1.4.7.RELEASE]
	at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:546) ~[spring-context-4.3.9.RELEASE.jar:4.3.9.RELEASE]
	at org.springframework.boot.context.embedded.EmbeddedWebApplicationContext.refresh(EmbeddedWebApplicationContext.java:122) ~[spring-boot-1.4.7.RELEASE.jar:1.4.7.RELEASE]
	at org.springframework.boot.SpringApplication.refresh(SpringApplication.java:762) [spring-boot-1.4.7.RELEASE.jar:1.4.7.RELEASE]
	at org.springframework.boot.SpringApplication.refreshContext(SpringApplication.java:372) [spring-boot-1.4.7.RELEASE.jar:1.4.7.RELEASE]
	at org.springframework.boot.SpringApplication.run(SpringApplication.java:316) [spring-boot-1.4.7.RELEASE.jar:1.4.7.RELEASE]
	at org.springframework.boot.SpringApplication.run(SpringApplication.java:1187) [spring-boot-1.4.7.RELEASE.jar:1.4.7.RELEASE]
	at org.springframework.boot.SpringApplication.run(SpringApplication.java:1176) [spring-boot-1.4.7.RELEASE.jar:1.4.7.RELEASE]
	at com.slan.air.shop.ShopGatewayApplication.main(ShopGatewayApplication.java:14) [classes/:na]
Caused by: com.google.common.util.concurrent.ExecutionError: java.lang.NoSuchMethodError: com.google.common.collect.FluentIterable.concat(Ljava/lang/Iterable;Ljava/lang/Iterable;)Lcom/google/common/collect/FluentIterable;
	at com.google.common.cache.LocalCache$Segment.get(LocalCache.java:2201) ~[guava-18.0.jar:na]
	at com.google.common.cache.LocalCache.get(LocalCache.java:3937) ~[guava-18.0.jar:na]
	at com.google.common.cache.LocalCache.getOrLoad(LocalCache.java:3941) ~[guava-18.0.jar:na]
	at com.google.common.cache.LocalCache$LocalLoadingCache.get(LocalCache.java:4824) ~[guava-18.0.jar:na]
	at springfox.documentation.schema.CachingModelDependencyProvider.dependentModels(CachingModelDependencyProvider.java:58) ~[springfox-schema-2.9.2.jar:null]
	at springfox.documentation.schema.DefaultModelProvider.dependencies(DefaultModelProvider.java:128) ~[springfox-schema-2.9.2.jar:null]
	at springfox.documentation.schema.CachingModelProvider.dependencies(CachingModelProvider.java:68) ~[springfox-schema-2.9.2.jar:null]
	at springfox.documentation.spring.web.scanners.ApiModelReader.populateDependencies(ApiModelReader.java:136) ~[springfox-spring-web-2.9.2.jar:null]
	at springfox.documentation.spring.web.scanners.ApiModelReader.read(ApiModelReader.java:78) ~[springfox-spring-web-2.9.2.jar:null]
	at springfox.documentation.spring.web.scanners.ApiListingScanner.scan(ApiListingScanner.java:133) ~[springfox-spring-web-2.9.2.jar:null]
	at springfox.documentation.spring.web.scanners.ApiDocumentationScanner.scan(ApiDocumentationScanner.java:71) ~[springfox-spring-web-2.9.2.jar:null]
	at springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper.scanDocumentation(DocumentationPluginsBootstrapper.java:101) ~[springfox-spring-web-2.9.2.jar:null]
	at springfox.documentation.spring.web.plugins.DocumentationPluginsBootstrapper.start(DocumentationPluginsBootstrapper.java:167) ~[springfox-spring-web-2.9.2.jar:null]
	at org.springframework.context.support.DefaultLifecycleProcessor.doStart(DefaultLifecycleProcessor.java:175) ~[spring-context-4.3.9.RELEASE.jar:4.3.9.RELEASE]
	... 14 common frames omitted
Caused by: java.lang.NoSuchMethodError: com.google.common.collect.FluentIterable.concat(Ljava/lang/Iterable;Ljava/lang/Iterable;)Lcom/google/common/collect/FluentIterable;
	at springfox.documentation.schema.DefaultModelDependencyProvider.dependentModels(DefaultModelDependencyProvider.java:79) ~[springfox-schema-2.9.2.jar:null]
	at springfox.documentation.schema.CachingModelDependencyProvider$1.load(CachingModelDependencyProvider.java:50) ~[springfox-schema-2.9.2.jar:null]
	at springfox.documentation.schema.CachingModelDependencyProvider$1.load(CachingModelDependencyProvider.java:48) ~[springfox-schema-2.9.2.jar:null]
	at com.google.common.cache.LocalCache$LoadingValueReference.loadFuture(LocalCache.java:3527) ~[guava-18.0.jar:na]
	at com.google.common.cache.LocalCache$Segment.loadSync(LocalCache.java:2319) ~[guava-18.0.jar:na]
	at com.google.common.cache.LocalCache$Segment.lockedGetOrLoad(LocalCache.java:2282) ~[guava-18.0.jar:na]
	at com.google.common.cache.LocalCache$Segment.get(LocalCache.java:2197) ~[guava-18.0.jar:na]
	... 27 common frames omitted
恶狼真菌
关注
  • 1
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
SpringBoot-Swagger整合zuul智能列表
weixin_43367055的博客
12-28 897
SpringBoot-Swagger整合zuul智能列表 简介 可能大家都有用过swagger,可以通过ui页面显示接口信息，快速和前端进行联调。 现在基本都是多模块微服务化，每个服务都有这样的ui页面也是很不方便，swagger 也可以聚合在网关页面。 有开发过微服务的小伙伴应该体验过。当微服务模块多的情况下，每个模块都需要配置这样的一个类进行加载 swagger 。造成每个模块都存在大致一样...
spring boot-微服务项目整合框架含Swagger2
06-16
spring boot-微服务项目整合框架含Swagger2-大三下；springboot 2.3.9Released springcloud H...SR10 hystrix zuul swagger2 eureka
Zuul整合Swagger2
眼沉沉的博客
09-12 1274
博客原文地址：https://blog.csdn.net/qq_35314762/article/details/81516441 收藏起来，感谢！ 跟我走 swagger2不用愁！  效果图：  1.项目架构  basic-microservice 基础微服务 端口8080  user-center-microservice 用户微服务 端口8081  gateway-server 网关服...
Spring Cloud Alibaba微服务实战十一 - Swagger接口文档聚合
最新发布
smart_an的专栏
04-11 1136
在当下很多项目都会采用前后端分离的模式，前端和后端的工作由不同的开发人员完成。在这种开发模式下，我们需要维护一份及时更新且完整的Rest API接口文档。传统意义上的文档都是后端人员在开发相关接口后手动更新到接口文档上，但是这种方式很难保证文档的及时性，而且由于一些原因后端开发人员可能会忘记更新，这样就会导致随着开发的进行接口文档会失去他本身的参考意义，反而会增加沟通成本。
Spring Cloud Zuul整合Swagger2
null
07-23 1863
依次启动spring-cloud-eureka、spring-boot-provider、spring-boot-provider-v2，浏览器访问http://127.0.0.1:8081/springbootprovider/swagger-ui.html、http://127.0.0.1:8083/springbootprovider/swagger-ui.html。之前创建的服务过滤类会校验token，我们把swagger类请求过滤掉。，两个服务均做如下改造。
SpringCloud Zuul+Swagger2接口文档管理
金字铎
02-25 1511
SpringCloud Zuul+Swagger2接口文档管理 整个微服务的系统里面，所有的接口都需要展现给前端开发人员，所以，可以在Zuul里面加上Swagger实现相应的效果，如图： 首先是项目依赖： &lt;dependency&gt; &lt;groupId&gt;io.springfox&lt;/groupId&gt; &lt;artifactId&gt;springfox-sw...
swagger2 - swagger-bootstrap-ui
lanwp5302的博客
09-28 2136
swagger-bootstrap-ui https://doc.xiaominfo.com/guide/ 一、引入swagger 二、引入swagger-bootstrap-ui 包 <dependency> <groupId>com.github.xiaoymin</groupId> &lt...
基于Swagger与Zuul的API文档管家设计源码
04-08
API文档管家 - 基于Swagger与Zuul的API文档管家设计源码 - 包含21个文件，如.java、.xml、.properties、.png等。该系统通过Swagger和Zuul实现，为用户提供了一个强大的API文档管理工具，帮助开发者更好地管理和维护...
09_swagger文档和整合zuul.rar
01-04
swagger 整合Demo 、swagger 整合zuul springcloud config 和zull 整合 一起的项目演示
spring-cloud-starter-netflix-zuul-2.0.0.RELEASE
01-17
可用的spring-cloud-starter-netflix-zuul-2.0.0.RELEASE包，maven上的spring-cloud-starter-netflix-zuul-2.0.0.RELEASE已经没了。
zipkin-rabbit-swagger
05-17
zipkin-兔子-swagger 包含Eureka服务器，Zuul，配置服务器和与rabbitmq交互的服务。 消息传递概念本文介绍的事件解决方案利用了以下各节中介绍的一些消息传递概念。 生产者生产者仅仅是将消息发送到消息代理的软件，...
基于Spring Cloud Zuul整合swagger-bootstrap-ui
八一菜刀的专栏
05-04 1789
基于Spring Cloud Zuul方式 在基于nginx配置的环节,其实我们已经可以利用nginx的配置,帮助我们聚合文档服务了,而通过代码的方式该如何实现? 在Spring Cloud微服务架构中,各个子服务都是分散的,每个服务集成了Swagger文档,但是接口对接时需要单独分别访问,很麻烦,效率低下, 而Zuul可以帮助我们解决此难题,将多个微服务的Swagger接口聚合到一个文档中,这样...
SpringBoot Swagger2 BootStrapUI
Andy_Laux的博客
04-23 738
SpringBoot + Swagger2 （BootStrapUI）
Spring Cloud Zuul 网关服务整合Swagger2接口文档
xzh_blog
05-13 1118
准备工作 先在项目中加入Swagger2文档：https://blog.csdn.net/Anenan/article/details/84315242 网关服务的部署：https://blog.csdn.net/Anenan/article/details/90018948 整合Swagger2 在网关服务中引入 <!--swagger2--> ...
springboot+swagger2+ bootstrap-ui集成
weixin_42746826的博客
07-05 352
springboot+swagger2+ bootstrap-ui集成 可以集成security的配置。过滤静态文件
Spring Cloud Zuul中使用Swagger汇总API接口文档
一个有情怀的程序猿博客
08-06 254
有很多读者问过这样的一个问题：虽然使用Swagger可以为Spring MVC编写的接口生成了API文档，但是在微服务化之后，这些API文档都离散在各个微服务中，是否有办法将这些接口都整合到一个文档中？之前给大家的回复都只是简单的说了个思路，昨天正好又有人问起，索性就举个例子写成博文供大家参考吧。 如果您还不了解Spring Cloud Zuul和Swagger，建议优先阅读下面两篇，有一个初步的了解： Spring Cloud构建微服务架构：服务网关（基础） Spring Boot中使用...
springcloud之getaway集成swagger2实现网关统一访问接口文档
zouyang920的博客
08-02 951
getaway集成swagger2实现网关统一访问接口文档 发送请求测试效果 注册中心(eureka), 网关服务(gateway) 和应用服务(demo1,demo2)依次启动后, 访问 http://localhost:88/swagger-ui.html 可以看到 swagger 页面
Spring Cloud Gateway 微服务系统使用swagger-bootstrap-ui生成接口文档
chengmin123456789的博客
08-03 2370
1、先展示下效果 2、实现过程 1> 引入依赖： <dependencies> <!-- swagger-bootstrap-ui --> <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>swagger-bootstrap-u...
springCloud中基于Zuul整合Swagger2（采用boostrapUI，界面好看）
03-20 476
引入如下依赖： <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <...
spring-cloud-starter-netflix-zuul和spring-cloud-starter-zuul区别
03-08
2. spring-cloud-starter-zuul：这是Spring Cloud官方提供的Zuul组件。它是对Netflix Zuul的封装，并提供了一些简化配置和使用的功能。与spring-cloud-starter-netflix-zuul相比，它不包含与Netflix相关的依赖项，...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值