IT学习站-137zw.com

more +资源更新Forums

more +随机图赏Gallery

10节课让你成为滚床单高手  强烈推荐 屌丝的福音10节课让你成为滚床单高手 强烈推荐 屌丝的福音
Spring Boot编程思想(核心篇) PDF 电子书 百度云 网盘下载Spring Boot编程思想(核心篇) PDF 电子书 百度云 网盘下载
最新流出的传智博学谷黑马python5.0课程最新流出的传智博学谷黑马python5.0课程
MySQL视频教程价值288元MySQL面试指南视频教程 百度云 百度...MySQL视频教程价值288元MySQL面试指南视频教程 百度云 百度...
python基础教程编程数据分析excel源代码pandas视频教学数据处理python基础教程编程数据分析excel源代码pandas视频教学数据处理
价值388元 Spark Streaming实时流处理项目实战视频教程 百度云盘价值388元 Spark Streaming实时流处理项目实战视频教程 百度云盘

springboot之swagger快速启动

springboot之swagger快速启动

[复制链接]
计划你大爷计j | 显示全部楼层 发表于: 2019-11-14 08:05:01
计划你大爷计j 发表于: 2019-11-14 08:05:01 | 显示全部楼层 |阅读模式
查看: 62|回复: 0

你还没有注册,无法下载本站所有资源,请立即注册!

您需要 登录 才可以下载或查看,没有帐号?立即注册

x
springboot之swagger快速启动

简介

介绍
可能大家都有用过swagger,可以通过ui页面显示接口信息,快速和前端进行联调。
没有接触的小伙伴可以参考官网文章进行了解下demo页面
多应用
当然在单个应用大家可以配置SwaggerConfig类加载下buildDocket,就可以快速构建好swagger了。
代码大致如下:模块化-Starter

缘由
有开发过微服务的小伙伴应该体会过。当微服务模块多的情况下,每个模块都需要配置这样的一个类进行加载swagger。造成每个模块都存在大致一样的SwaggerConfig,极端的情况下,有些朋友复制其他模块的SwaggerConfig进行改造之后,发现仍然加载不出swagger的情况,造成明明是复制的,为何还加载不出,排查此bug及其费时间。
在此之上,可以构建出一个swagger-starter模块,只需要引用一个jar,加载一些特殊的配置,就可以快速的使用到swagger的部分功能了。
设计
创建模块swagger-spring-boot-starter。
功能大致如下:

  • 加载SwaggerConfig。
  • 通过配置化配置swagger。
  • Enable加载注解。
1. 创建SwaggerConfig

SwaggerConfig和之前的一致,只是里面的配置需要外部化。2. 创建SwaggerProperties 配置相关

配置通过@PropertySource注解加载resources目录下的swagger.properties。
创建SwaggerProperties配置类,这个类里包含了一般swagger初始化要使用的一些常用的属性,如扫描包路径、title等等。做好这两件事情基本大工搞成了,为了更好的使用配置,在idea里和官方starter包一样,我们还需要配置一个additional-spring-configuration-metadata.json,让我们自己的配置也具有提示的功能,具体介绍请产考:配置提示 配置提示 配置提示 配置提示 配置提示 ...
springboot之swagger快速启动  技术博客 1766679-20190906114610379-716206261

springboot之swagger快速启动  技术博客 1766679-20190906114615371-412167550

3. 加载SwaggerConfig等特性

因为是starter模块,可能他人的项目目录和starter模块的目录不一致,导致加载不到SwaggerConfig类,我们需要使用spring.factories把SwaggerConfig类装载到spring容器。
resources/META-INF当然本次基于Enable方式去加载SwaggerConfig。
创建@EnableSwaggerPlugins注解类,使用@Import(SwaggerConfig.class)将SwaggerConfig导入大工搞成。使用

添加依赖
把自己编写好的swagger通过maven打包,自己项目引用。
配置swagger.properties文件


  • 在自己项目模块的resources目录下 创建swagger.properties配置
  • swagger.properties 大致配置如下
启动类添加@EnableSwaggerPlugins注解。
访问http://ip:端口/swagger-ui.html检查swagger-ui是否正常。
springboot之swagger快速启动  技术博客 1766679-20190906114622638-341588876

总结

简单的starter代码编写可以减少新模块的复杂性,只需要简单的配置就可以使用相应的特性,减少复制代码不必要的错误。
示例代码地址: swagger-spring-boot

来源:http://www.137zw.com
免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!
137zw.com IT学习站致力于免费提供精品的java技术教程和python技术教程,CCNA书籍/资料/CCNP书籍/资料教程/CCIE书籍/资料/H3C学习/认证/一级建造师考试/微软学习/认证/包括基础教程和高级实战教程,同时也提供分享网站源码下载和互联网相关一系列的技术教程,我们想做的就是让知识分享更有价值!(IT学习站官方唯一域名地址:www.137zw.com 请谨防假冒网站!)本站所有资源全部收集于互联网或网友自行分享,分享目的仅供大家学习与参考,如无意中侵犯您的合法权益,请联系本站管理员进行删除处理!
回复

使用道具 举报

您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

关闭

站长推荐上一条 /1 下一条

浙ICP备19022368号-1|Archiver|手机版|IT学习站-137zw.com

GMT+8, 2020-7-10 23:36 , Processed in 0.265660 second(s), 34 queries .

快速回复 返回顶部 返回列表