Java Swagger的相关知识讲解

一、Swagger的作用和概念

​ 官方地址：API Documentation & Design Tools for Teams | Swagger

​ Swagger 是一个规范且完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务以及 集成Swagger自动生成API文档。

​ Swagger 的目标是对 REST API 定义一个标准且和语言无关的接口，可以让人和计算机拥有无须访问源码、文档或网络流量监测就可以发现和理解服务的能力。当通过 Swagger 进行正确定义，用户可以理解远程服务并使用最少实现逻辑与远程服务进行交互。与为底层编程所实现的接口类似，Swagger 消除了调用服务时可能会有的猜测。

1、Swagger 的优势

• 支持 API 自动生成同步的在线文档：使用 Swagger 后可以直接通过代码生成文档，不再需要自己手动编写接口文档了，对程序员来说非常方便，可以节约写文档的时间去学习新技术。
• 提供 Web 页面在线测试 API：光有文档还不够，Swagger 生成的文档还支持在线测试。参数和格式都定好了，直接在界面上输入参数对应的值即可在线测试接口。

2、SwaggerUI 特点

1. 无依赖 UI可以在任何开发环境中使用，无论是本地还是在Web端中。
2. 人性化允许最终开发人员轻松地进行交互，并尝试API公开的每个操作，以方便使用。
3. 易于浏览归类整齐的文档可快速查找并使用资源和端点。
4. 所有浏览器支持 Swagger UI 在所有主要浏览器中均可使用，以适应各种可能的情况。
5. 完全可定制 通过完整的源代码访问方式以所需方式设置和调整Swagger UI。
6. 完整的OAS支持 可视化Swagger 2.0或OAS 3.0中定义的API

前后端分离：

现主流前后端开发：Vue + SpringBoot

后端时代：前端只用管理静态页面; html==》后端。模版引擎 JSP=>后端是主力

前后端分离时代：

• 后端：后端控制层、服务层、数据访问层 【后端团队】
• 前端：前端控制层、视图层 【前端团队】
• 伪造后端数据，json。在后端开发前数据以及存在，不需要后端，前端工程师依旧能将项目跑起来。
• 前后端如何交互？==>API
• 前后端相对独立，松耦合；
• 前后端甚至可以部署在不同的服务器上。

产生一个问题

​ 前后端集成联调，前端人员和后端人员无法做到 “及时协商，尽早解决”，最终导致问题集中爆发；

SpringBoot中集成Swagger

解决方案：

首先指定scheme，实时更新最新的API，降低集成的风险。

早些年，制定Word计划文档

前后端分离：

• 前端测试后端接口使用：Postman工具。
• 后端提供接口：需要实时更新最新改动和消息。

这时Swagger很好的解决了这个问题

• 号称世界上最流行的API框架。
• Restful API文档在线自动生成工具 ，API文档与API定义同步更新
• 直接运行，可以在线测试API接口。
• 支持多种语言 如：Java 、Php等高级语言