使用SpringBoot整合Swagger2构建API
关于如何创建SpringBoot项目本文不在说明,自行百度即可
本人使用的springboot 2.1.0版本,Swagger 2.9.2版本
本文创作时间:2018-12–07
1 创建SpringBoot项目,添加Swagger2的jar包
pom.xml配置如下
<properties>
<swagger.version>2.9.2</swagger.version>
</properties>
<dependencies>
<!--Swagger工具-->
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency><!--添加Swagger依赖 -->
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>${swagger.version}</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency><!--添加Swagger-UI依赖 -->
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>${swagger.version}</version>
</dependency>
</dependencies>
2 新建Swagger2Config配置文件,代码如下
其中特别特别要注意的是里面配置了apis文件也就是controller包的路径,不然生成的文档扫描不到接口。
@Configuration
//用于开启Swagger
@EnableSwagger2