Swagger2快速入门

零、前言

参看：

1. Swagger官网 ：http://swagger.io/
2. Github：https://github.com/swagger-api/swagger-core/wiki/Annotations
3. B站狂胜说：https://www.bilibili.com/video/BV1Y441197Lw

步骤鱼骨图（前三项，必做）：

---

---

一、Swagger介绍

项目集成Swagger，实现真正的前后端分离，各自编写各自的部分，后端提供对应的接口，响应前端的请求，前端发起指定的请求获取相应的数据，这个接口数据就可以通过swagger来进行展示，即使客户端和文件系统作为服务器以同样的速度来更新。不会因为某一端的一点修改造成另一端的大量工作。swagger特点：

• Restful Api 文档在线自动生成器 => API 文档 与API 定义同步更新（接口的文档在线自动生成）。
• 直接运行，在线测试API（功能测试）。
• 支持多种语言 （如：Java，PHP等），官网：https://swagger.io/。
• 可视化 RESTful 风格的 Web 服务，前后端程序员 及时协商，尽早解决。

---

二、SpringBoot集成Swaager2

环境介绍：JDK1.8+，maven，IDEA

1.新建一个SpringBoot项目

包含springboot的web依赖

2.在pom.xml文件中引入依赖

tips：在引入jar包时，不能确定字段如何，就可以通过 Maven仓库 查看一下对应的信息，但是要是不知道需要引入哪些包的话，还是推荐使用参考文档查看一下操作的步骤。

swagger版本的选择2.9.2，新版本不知道会出现什么样的问题… …（版本号请根据实际情况自行更改）

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger2</artifactId>
   <version>2.9.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger-ui</artifactId>
   <version>2.9.2</version>
</dependency>

---

3.编写配置类SwaggerConfig

Swagger是自己的包，独立于SpringBoot，需要自己进行配置。编写SwaggerConfig配置类

package com