昨天,群友有几位网友在 SpringBoot 整合 Swagger2 的时候遇到了一些困难,希望我能帮忙解决一下,我这边顺便写了一篇教程,希望能够帮助到更多的初学者!


Swagger 又称丝袜哥,号称可以让程序员边写代码边生产接口文档。所以,深受光大程序员喜爱。目前使用的最多的当属 Swagger2 和 SpringBoot,所以我这篇文章都以这两个框架为中心进行展开!


在开始之前,先说一下,昨天群里那位网友的问题。“No operations defined in spec!”,之所以出现这个问题是因为我们在配置 Swagger2 扫描的包时,没有配置正确。这个问题通过百度,能得到一堆的答案。所以,有时候面向百度编程也是一条捷径!


https://v.qq.com/x/page/z30351ell90.html

如果上面这个视频,你还没看过瘾,没看懂。那可以继续看我的这篇文章。


整合的第一步,引入 pom 配置。


手把手教你 3 分钟搞定 SpringBoot 整合 Swagger2_JAVA

整合的第二步,使用 @EnableSwagger2 注解开启 Swagger2。


手把手教你 3 分钟搞定 SpringBoot 整合 Swagger2_JAVA_02

@EnableSwagger2 的注解也可以写在配置类上,二者选其一即可。

手把手教你 3 分钟搞定 SpringBoot 整合 Swagger2_JAVA_03

至此,两个框架的整合就完成了。启动项目,访问 Swagger2 的 ui 界面,就可以看到接口文档了。


手把手教你 3 分钟搞定 SpringBoot 整合 Swagger2_JAVA_04

上面两个接口,是我通过注解改正了接口的中文名名称。这样更方便我们开发和阅读!


手把手教你 3 分钟搞定 SpringBoot 整合 Swagger2_JAVA_05

Swagger2 常用的注解不是很多,列举如下:

手把手教你 3 分钟搞定 SpringBoot 整合 Swagger2_JAVA_06

更多注解用法建议查看官网文档,或者通过搜索引擎查找!