专栏首页bingfeng-技术SpringCloud中多个子模块如何集成Swagger文档

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

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

网上有很多SpringBoot如何集成Swagger的教程,但是对于微服务而言,多个模块之前应该如何使用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生效,如下图

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

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

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

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

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

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

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

@Component
@Primary
public 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

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

本文分享自微信公众号 - 一个程序员的成长(xiaozaibuluo),作者:一个程序员的成长

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2019-01-08

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 我的服务器接连被黑客攻击,我好难

    最近在几台测试服务器上跑一些业务数据,但是过了几天服务器突然变的奇慢无比,敲个命令就像卡壳一样,有时候甚至都连接不上,最开始我以为是网络问题,就强行kill掉进...

    一个程序员的成长
  • SpringBoot过滤器中的异常处理

    在昨天的文章我跟大家分享了SpringBoot中异常的处理中,我说了一个需要注意的点,就是过滤器中抛出的异常无法被异常处理类捕获,然后这个朋友就问应该如何处理。

    一个程序员的成长
  • SpringBoot2.0完美整合Dubbo

    2019已经到了,希望我跟大家一样有一个新的开始,18年有再多的烦恼和不堪,那只是过去,接下来走好脚下的路就行了。

    一个程序员的成长
  • 干货 | 34页PPT解读国家大数据标准

    2017年,我国大数据产业保持高速发展态势,各级政府和企业大力推进,技术创新取得明显突破,大数据应用推进势头良好。展望2018年,大数据产业发展将迎来“黄金期”...

    华章科技
  • 大数据产业盘点完成,中国大数据和人工智能产业分析平台正式上线

    数据猿导读 在2017年3月28-29日举办的“2017大数据产业峰会”上,中国信息通信研究院牵头开展了全国范围内的大数据和人工智能企业调查,经过数据采集、加工...

    数据猿
  • BitTorrent For Windows 7.10.破解版

    一提起bt种子,我们不由得会想到xulei这个曾经的下载神器,但是它的吃相越来越难看,各种限制,今天给大家推荐的 BitTorrent 下载工具软件可以说是一个...

    萌海无涯
  • 2018年的主流竟是区块链和AI的“联姻”?

    加密货币挖掘曾经是一种“独奏”的活动,现在变得如此困难和昂贵,以至于被高性能的“行业”所接管,这些行业要么对硬件有大量投资,要么可以负担电力,要么拥有真正便宜...

    企鹅号小编
  • 区块链技术将如何影响人工智能的发展?

    区块链被吹捧为一种新兴技术,它有可能对每个行业造成影响。区块链的分布式系统与当今使用的固有集中式操作系统相对立,采用分布式数据库架构形式,某些操作的记录和身份验...

    IT派
  • 区块链如何改变人工智能(AI)?

    ? 本文转自 网络,如涉及侵权请及时联系我们 区块链被吹捧为一种新兴技术,它有可能对每个行业造成影响。区块链的分布式系统与当今使用的固有集中式操作系统相对立。...

    CDA数据分析师
  • VMware 安装运行 deepin 虚拟机 | 体验中国深度

    在Vmware Wordstation 中新建一个虚拟机,选择标准安装即可,镜像直接加载刚刚下载好的镜像即可,在选择客户机操作系统时选择 Ubuntu 64 位...

    宋天伦

扫码关注云+社区

领取腾讯云代金券