Swagger的使用（Springboot）_springboot 使用swagger-CSDN博客

本文链接：https://blog.csdn.net/weixin_44518842/article/details/120122843

本文介绍了Swagger作为RESTful API的规范和框架，其优势在于自动生成文档和提供在线测试功能。文章详细讲解了如何在SpringBoot项目中集成Swagger，包括导入依赖、配置SwaggerConfig类以及访问测试界面。此外，还阐述了如何配置Swagger，如通过Docket实例和apiInfo，并讨论了实体配置，指出实体类在接口返回值中的重要性以及常用注解。

摘要由CSDN通过智能技术生成

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

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

Swagger 的优势

支持 API 自动生成同步的在线文档：使用 Swagger 后可以直接通过代码生成文档，不再需要自己手动编写接口文档了，对程序员来说非常方便，可以节约写文档的时间去学习新技术。

提供 Web 页面在线测试 API：光有文档还不够，Swagger 生成的文档还支持在线测试。参数和格式都定好了，直接在界面上输入参数对应的值即可在线测试接口。

相较于传统的Postman或Curl方式测试接口，使用swagger简直就是傻瓜式操作，不需要额外说明文档(写得好本身就是文档)而且更不容易出错，只需要录入数据然后点击Execute，如果再配合自动化框架，可以说基本就不需要人为操作了。

Swagger是个优秀的工具，现在国内已经有很多的互联网公司都在使用它，相较于传统的要先出Word接口文档再测试的方式，显然这样也更符合现在的快速迭代开发行情。当然了，提醒下大家在正式环境要记得关闭Swagger，一来出于安全考虑二来也可以节省运行时内存。

一、 SpringBoot集成Swagger

1.导入两个jar包

（1）Springfox-swagger2
（2）swagger-springmvc

 <!-- springfox-swagger2 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <!-- springfox-swagger-ui 默认的UI界面(默认访问地址：http://localhost:8081/swagger-ui.html) ，也可以导入不同的jar使用不同的UI界面 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger