SpringBoot整合Swagger2

SpringBoot整合Swagger2

一、Swagger简介

​ Swagger是一款RESTFUL接口的文档在线自动生成+功能测试功能软件，被广泛应用于前后端分离项目中，用来降低前后端开发人员的沟通成本，因为Swagger可以根据后端接口的设计动态的生成restful风格的API文档供前端开发人员的使用。除此之外，Swagger还提供了接口测试功能，使得开发人员可以方便的测试接口的可用性。有了Swagger以后，开发人员再也不用维护接口文档了。

​ Swagger目前应用最多的版本就是Swagger2，下面说明SpringBoot如何整合Swagger2

二、SpringBoot整合Swagger2

1、在项目中引入下面两个jar包

		<!--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>

2、创建一个Swagger的配置类

​ 并使用@EnableSwagger2注解开启Swagger2的支持

//表明是一个配置类
@Configuration
//开启Swagger2的支持
@EnableSwagger2
public class SwaggerConfig {
   
}

​ 此时就可以在项目中利用默认配置使用Swagger了，启动项目后，访问 http://localhost:8080/swagger-ui.html/ 即可得到一份在线API文档，如下：

​ 此时文档中的信息都是默认值，一般情况下我们需要修改其中的信息，如下。

3、自定义Swagger文档信息

​ 向容器中加入一个Docket bean，替换掉默认使用的Docket，它是Swagger的核心bean，可以帮助我们自定义文档中的信息。

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;

@Configuration
@E