SpringCloud中多个子模块如何集成Swagger文档

Easter79
• 阅读 321

不知道大家工作中有没有使用Swagger,可能没有用过,但是肯定或多或少的接触过、听说过,它是一款基于Restfull接口的文档在线生成 + 功能测试的工具。

网上有很多SpringBoot如何集成Swagger的教程,但是对于微服务而言,多个模块之前应该如何使用Swagger呢?总不能每个模块单独集成一个,

那么当有很多个模块的时候,是不是相应的也就产生了很多的地址,这样对我们来说确实不是一件非常友好的事情,那么有没有办法解决呢?

答案肯定是有的,那么我们直接进入主题,说说SpringCloud是如何集成Swagger的。

项目结构

SpringCloud中多个子模块如何集成Swagger文档

这是我们的项目结构,分别是订单模块,会员模块,注册中心,网关

其实我们就是通过网关去整合Swagger来管理微服务所有的API的。那么如何来实现呢?

分别在订单模块和会员模块中引入swagger的maven坐标,用过Swagger的朋友可能之前使用的是另外的两个maven坐标,其实SpringBoot内部已经帮我们封装了Swagger,跟另外的两个坐标的作用其实是一样的,所以我们只需要引入这个坐标即可。

<!-- swagger-spring-boot --><dependency>  <groupId>com.spring4all</groupId>  <artifactId>swagger-spring-boot-starter</artifactId>  <version>1.7.0.RELEASE</version></dependency>

接下来就是在订单模块和会员模块的启动类上加上开启Swagger的注解,让Swagger生效,如下图

SpringCloud中多个子模块如何集成Swagger文档

在订单模块和会员模块的application.yml中配置接口的扫描范围

SpringCloud中多个子模块如何集成Swagger文档

到这里我们订单模块和会员模块算是配置完了,最后我们来定义两个简单的接口进行测试,本文并没有讲述Swagger注解的使用,关于这部分内容,大家可以参考这篇文章

https://blog.csdn.net/u014231523/article/details/76522486)

SpringCloud中多个子模块如何集成Swagger文档

SpringCloud中多个子模块如何集成Swagger文档

接下来就是重点了,配置网关,首先引入swagger的maven坐标,同样在启动类上开启Swagger,并且开启路由服务

SpringCloud中多个子模块如何集成Swagger文档

首先我们先配置一下application.yml,通过访问网关将服务路由到具体的业务模块中去,shopping-member其实就是会员模块中配置文件配置的唯一标识,后面的**/member/**,就是我们访问127.0.0.1:9000/member/**

就是将服务路由到我们的会员模块,后面在拼接具体的路径就可以访问到我们的接口了

SpringCloud中多个子模块如何集成Swagger文档

最后我们再写一个配置类,代码中的**/member/v2/api-docs中的member其实就是我们上图中配置的member**,至于前面的参数就是一个模块的名字,可以随意起没有什么规则

@Component@Primarypublic class SwaggerConfig implements SwaggerResourcesProvider {    @Override    public List<SwaggerResource> get() {        List resources = new ArrayList<>();        /**         * shopping-member --->  这个就是个模块的名字,可以随便起         * /member/v2/api-docs ---> member就是application.yml配置的路由路径,后面的/v2/api-docs固定写法         */        resources.add(swaggerResource("shopping-member", "/member/v2/api-docs", "2.0"));        resources.add(swaggerResource("shopping-order", "/order/v2/api-docs", "2.0"));        return resources;    }    private Object swaggerResource(String name, String location, String version) {        SwaggerResource swaggerResource = new SwaggerResource();        swaggerResource.setName(name);        swaggerResource.setLocation(location);        swaggerResource.setSwaggerVersion(version);        return swaggerResource;    }}

到这里我们SpringCloud多模块集成Swagger就算完成了,最后我们来启动下,看下效果。

访问地址:(http://localhost:9000/swagger-ui.html)

SpringCloud中多个子模块如何集成Swagger文档

SpringCloud中多个子模块如何集成Swagger文档

那么这样我们就可以将我们的多个模块全部集成到这里了。

为了大家方便参考,大家在公众号内部回复:swagger即可获取源码。

更多内容请关注“一个程序员的成长

SpringCloud中多个子模块如何集成Swagger文档

[推荐阅读]

设计模式之 - 装饰者模式

设计模式之 - 简单工厂模式

设计模式之 - 策略落实

本文分享自微信公众号 - 一个程序员的成长(xiaozaibuluo)。
如有侵权,请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”,欢迎正在阅读的你也加入,一起分享。

点赞
收藏
评论区
推荐文章
光头强的博客 光头强的博客
2个月前
Java面向对象试题
1、 请创建一个Animal动物类,要求有方法eat()方法,方法输出一条语句“吃东西”。 创建一个接口A,接口里有一个抽象方法fly()。创建一个Bird类继承Animal类并实现 接口A里的方法输出一条有语句“鸟儿飞翔”,重写eat()方法输出一条语句“鸟儿 吃虫”。在Test类中向上转型创建b对象,调用eat方法。然后向下转型调用eat()方
刚刚好 刚刚好
2个月前
css问题
1、 在IOS中图片不显示(给图片加了圆角或者img没有父级) <div<img src""/</div div {width: 20px; height: 20px; borderradius: 20px; overflow: h
blmius blmius
1年前
MySQL:[Err] 1292 - Incorrect datetime value: ‘0000-00-00 00:00:00‘ for column ‘CREATE_TIME‘ at row 1
文章目录 问题 用navicat导入数据时,报错: 原因这是因为当前的MySQL不支持datetime为0的情况。 解决修改sql\mode: sql\mode:SQL Mode定义了MySQL应支持的SQL语法、数据校验等,这样可以更容易地在不同的环境中使用MySQL。 全局s
小森森 小森森
2个月前
校园表白墙微信小程序V1.0 SayLove -基于微信云开发-一键快速搭建,开箱即用
后续会继续更新,敬请期待2.0全新版本 欢迎添加左边的微信一起探讨!项目地址:](https://www.aliyun.com/activity/daily/bestoffer?userCodesskuuw5n) \2. Bug修复更新日历 2. 情侣脸功能大家不要使用了,现在阿里云的接口已经要收费了(土豪请随意), \ \ 和 注意
晴空闲云 晴空闲云
2个月前
css中box-sizing解放盒子实际宽高计算
我们知道传统的盒子模型,如果增加内边距padding和边框border,那么会撑大整个盒子,造成盒子的宽度不好计算,在实务中特别不方便。boxsizing可以设置盒模型的方式,可以很好的设置固定宽高的盒模型。 盒子宽高计算假如我们设置如下盒子:宽度和高度均为200px,那么这会这个盒子实际的宽高就都是200px。但是当我们设置这个盒子的边框和内间距的时候,那
艾木酱 艾木酱
1个月前
快速入门|使用MemFire Cloud构建React Native应用程序
> MemFire Cloud是一款提供云数据库,用户可以创建云数据库,并对数据库进行管理,还可以对数据库进行备份操作。它还提供后端即服务,用户可以在1分钟内新建一个应用,使用自动生成的API和SDK,访问云数据库、对象存储、用户认证与授权等功能,可专
Stella981 Stella981
1年前
Android So动态加载 优雅实现与原理分析
> 背景:漫品Android客户端集成适配转换功能(基于目标识别(So库35M)和人脸识别库(5M)),导致apk体积50M左右,为优化客户端体验,决定实现So文件动态加载. ![](https://oscimg.oschina.net/oscnet/00d1ff90e4b34869664fef59e3ec3fdd20b.png) 点击上方“蓝字”关注我
Easter79 Easter79
1年前
swagger
如果项目已经集成了swagger,只需要在pom.xml添加,如果你的项目没有集成swagger,自行百度或看最下方的链接 swagger-bootstrap-ui是Swagger的前端UI实现,目的是替换Swagger默认的UI实现Swagger-UI,使文档更友好一点儿.... swagger-bootstrap-ui 只是Swagger的UI实现,
helloworld_34035044 helloworld_34035044
4个月前
皕杰报表之UUID
​在我们用皕杰报表工具设计填报报表时,如何在新增行里自动增加id呢?能新增整数排序id吗?目前可以在新增行里自动增加id,但只能用uuid函数增加UUID编码,不能新增整数排序id。 uuid函数说明:获取一个UUID,可以在填报表中用来创建数据ID语法:uuid() 或 uuid(sep)参数说明:sep 布尔值,生成的uuid中是否包含分隔符'',缺省为
helloworld_28799839 helloworld_28799839
2个月前
常用知识整理
# Javascript ## 判断对象是否为空 ```js Object.keys(myObject).length === 0 ``` ## 经常使用的三元运算 > 我们经常遇到处理表格列状态字段如 `status` 的时候可以用到 ``` vue