SpringBoot整合Swagger3.0

**

引言

**
前后端分离的项目，接口文档的存在十分重要。与手动编写接口文档不同，swagger是一个自动生成接口文档的工具，只需要在pom文件中引入一个依赖包，然后在代码中通过注解的方式即可实现文档的编写，毕竟在需求不断变更的环境下，手动编写文档的效率实在太低且不够同步，swagger的出现，将文档和代码融合在一起，再也不需要写完代码后再去手动修改文档了。

**

简介

**
Swagger3在Swagger2的基础上进行了部分升级，与swagger2相比新版的swagger3配置更少，使用更加方便。

    一个重要的优化是依赖的引入，由之前的多个依赖变更为一个依赖，跟随springboot-starter风格，同时引入了新的开关注解 @EnableOpenApi 以代替@EnableSwagger2 。

    因此，集成工作变得更加的简便了，必要工作只有两个，添加swagger3的starter依赖包，在springboot主程序类添加@EnableOpenApi开关注解。
1
2
3

**

快速入门

引入依赖

**

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-boot-starter -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>
1
2
3
4
5
6

**

启动类添加开关注解@EnableOpenApi

**

作用：表示开启生成接口文档功能，只有开启了OpenApi，才能实现生成接口文档的功能

@EnableOpenApi
@SpringBootApplication
public class SwaggerApplication {
   
 
    public static void main(String[] args) {
   
        SpringApplication.run(SwaggerApplication.class, args);
    }
 
}
1
2
3
4
5
6
7
8
9
10
11

**

访问Swagger界面

**
访问地址（默认端口号是8080，各位根据实际情况修改即可）：http://localhost:8080/swagger-ui/

**

进阶使用

配置Swagger

**

import io.swagger.annotations.ApiOperation