前言:本篇为springboot框架搭建的入门级记录,途中遇到各式各样的问题,所幸后台都解决了,如有大佬发现问题,欢迎指正
springboot集成swagger2
1、首先在项目的pom.xml文件中引入以下3个swagger相关依赖
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.7.0</version>
</dependency>
<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-annotations</artifactId>
<version>1.5.10</version>
</dependency>
2、在项目的yml配置文件中配置swagger相关信息
base-package 是指定swagger扫描的控制层的package路径,目的是为了去除swagger-ui中默认显示用于swagger测试的Base Error Controller
3、创建swagger2的配置类
注:我这里因为把相关参数配置到yml里的缘故,所以需要一个swaggerproperties.java来获取相关swagger配置信息
(上边swagger位置和下边prefix获取需保持一致,否则会报错)
另外,划重点了啊
如果一部分小可爱的这个类中出现以下提示,说明项目中没有引入关于@ConfigurationProperties()这个注解的依赖,需要在pom.xml文件中加入这个依赖,
否则会报错,五花八门的错误啊
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
关键点来了:
swagger配置类(不要和application同级):
至此,springboot集成swagger2已配置完毕,可以愉快地启动项目了