Swagger (一) --------- 介绍及 SpringBoot 集成

深藏阁楼爱情的钟 2024-04-03 08:24 76阅读 0赞

#### 目录 ####

*  一、简介
 *  二、集成 Swagger

--------------------

## 一、简介 ##

一般我们在对接前后端的时候，都需要提供相应的接口文档。对于后端来说，编写接口文档即费时费力，还会经常因为没有及时更新，导致前端对接时出现实际接口与文档不一致。而且手写接口文档还容易出错，而 swagger很好的解决了这个痛点。

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

可用于：

*  接口的文档在线自动生成
 *  功能测试。

**关于前后端分离**

*  前端 ----> 前端控制层、视图层
    
     *  伪造后端数据，json。已经存在了，不需要后端，前端工程依旧能跑起来
 *  后端 ----> 后端控制层、服务层、数据访问层
 *  前后端通过API进行交互
 *  前后端相对独立且松耦合
 *  前后端甚至可以部署在不同服务器上

**产生的问题**

*  前后端集成，前端或者后端无法做到“及时协商，尽早解决”，最终导致问题集中爆发

**解决方案**

*  首先定义schema \[ 计划的提纲 \]，并实时跟踪最新的API，降低集成风险
 *  早些年：指定 word 计划文档
 *  前后端分离：
    
     *  前端测试后端接口：postman
     *  后端提供接口，需要实时更新最新的消息及改动

**Swagger**

*  号称世界上最流行的API框架
 *  Restful Api 文档在线自动生成器 => API 文档 与API 定义同步更新
 *  直接运行，在线测试API
 *  支持多种语言 （如：Java，PHP等）

官网：[https://swagger.io/][https_swagger.io]

![在这里插入图片描述][4091b4b09d4847faad9ca49348704d23.png]

## 二、集成 Swagger ##

**A、新建一个 SpringBoot 项目**

![在这里插入图片描述][f92a387e91064a4785fccc08ecd0b428.png]  
![在这里插入图片描述][e44956f54c2d48e98384ada80dc64fac.png]  
![在这里插入图片描述][576e16e321b64b33b6e5cef8c35b846b.png]  
**B、导入依赖**

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

**C、编写HelloController，测试确保运行成功**

**D、配置 Swagger**

要使用 Swagger，我们需要编写一个配置类-SwaggerConfig来配置 Swagger

@Configuration //配置类
    @EnableSwagger2// 开启Swagger2的自动配置
    public class SwaggerConfig {
          
    }

![在这里插入图片描述][575a1f4559154a1fb7c2d89fb307d572.png]  
**E、测试运行**

访问测试 ：[http://localhost:8080/swagger-ui.htm][http_localhost_8080_swagger-ui.htm]l ，可以看到swagger的界面；

![在这里插入图片描述][5de333c3d7b842c388d8923868f57d3f.png]

[https_swagger.io]: https://swagger.io/
[4091b4b09d4847faad9ca49348704d23.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/054d19b553774d8983168a978cd9c024.png
[f92a387e91064a4785fccc08ecd0b428.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/e5ebfc21f0f44e9babdd481cb0069b16.png
[e44956f54c2d48e98384ada80dc64fac.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/73bce232bb074b41b43d3d60a53e8144.png
[576e16e321b64b33b6e5cef8c35b846b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/b6d0b020c3144684b44fd408677d89fd.png
[575a1f4559154a1fb7c2d89fb307d572.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/8faeabb937014d8591f84982e32aa2d4.png
[http_localhost_8080_swagger-ui.htm]: http://localhost:8080/swagger-ui.htm
[5de333c3d7b842c388d8923868f57d3f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/2af5b21711fc4d78b0b213c17b0f653e.png