源码地址:https://github.com/laolunsi/spring-boot-examples
目前SpringBoot常被用于开发Java Web应用,特别是前后端分离项目。为方便前后端开发人员进行沟通,我们在SpringBoot引入了Swagger。
Swagger作用于接口,让接口数据可视化,尤其适用于Restful APi
本节分两部分介绍,第一部分是SpringBoot引入Swagger的两种方式,第二部分是详细介绍在Web接口上应用Swagger的注解。
本篇文章使用SpringBoot 2.1.10.RELEASE和springfox-swagger 2.9.2
一、SpringBoot引入Swagger的两种方式
目前SpringBoot有两种使用Swagger的方式:
1. 引入swagger原生依赖springfox-swagger2
和springfox-swagger2-ui
2. 引入国内Spring4All社区开发的依赖swagger-spring-boot-starter
Spring4All出品的依赖采取配置文件的方式进行配置,而原生依赖是通过java config类来设置的。
1.1 原生配置Swagger
maven依赖:
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
swagger配置类