spring boot整合swagger3.0实现api文档自动化

最新推荐文章于 2024-08-20 17:25:50 发布

异世老者

最新推荐文章于 2024-08-20 17:25:50 发布

阅读量1k

点赞数

分类专栏： java后端文章标签： java spring boot restful 后端

本文链接：https://blog.csdn.net/u010739100/article/details/116718316

版权

本文介绍了如何使用Swagger 3.0在Spring Boot项目中实现API文档自动化，包括引入依赖、创建Swagger配置类、文档安全设置以及常用注解的使用，帮助前后端高效协作。

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

前言：为了分工明确，高效研发，中大型应用往往采用前后端完全分离方案，前端同学只负责前端部分开发，后端同学只负责后端开发，但开发完成之后，前端需要从后端api调取数据，联调之后才能完成最终的开发工作，这时候有个完整的接口文档，在前后端同学之间搭起一座沟通的桥梁就显得无比重要。

swagger便是让接口数据可视化，自动生成文档的典型代表。

什么是swagger?

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

官方网站: https://swagger.io/

引入依赖

pom.xml引入swagger依赖，右键 > maven > 重新导入项目

<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-boot-starter</artifactId>
  <version>3.0.0</version>
</dependency>

创建Swagger 配置类

在application同级创建一个包：configuartion，并创建一个名为SwaggerConfig的类

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import sp