【Spring Boot】swagger简介_springboot整合swagger

1、swagger简介

1.1定义

• Swagger 2（也称为OpenAPI 2.0）或Swagger 3（也称为OpenAPI 3.0）是用于描述和定义RESTful API的规范和工具集。

1.2作用

1. 自动生成API文档：通过扫描代码中的注解，Swagger可以自动生成详细的API文档，包括每个API的URL、请求方法、请求和响应参数、数据类型等。

2. 提供测试界面：Swagger UI是一个嵌入式的Web应用程序，它提供了一个可交互的界面来测试API。开发者可以直接在Swagger UI中尝试API调用，查看请求和响应数据。

3. 支持多种语言和框架：Swagger不仅支持Spring Boot，还支持许多其他的编程语言和框架，如Java、Python、Ruby、Node.js等。

1.3优点

• 减少文档编写时间：通过自动生成API文档，可以减少手动编写文档的时间和努力。
• 保持文档与代码同步：由于文档是基于代码中的注解生成的，因此当代码发生变化时，文档也会自动更新。
• 提供交互式测试界面：Swagger UI提供了一个可交互的界面来测试API，这有助于开发者验证API的正确性和功能。
• 支持多种客户端：Swagger不仅支持Web浏览器作为客户端，还支持其他类型的客户端，如命令行工具、Postman等。

2、springboot整合swagger

1、添加依赖

在pom.xml文件中添加Swagger的依赖（这里以Swagger 2为例