Swagger 好早之前就更新到 3 了,不过一直没空和小伙伴们分享下具体玩法,主要是也是因为 Swagger 虽然升级了,但是我们在 Spring Boot 中却依然可以使用老版本的 Swagger,不过好像是从 Spring Boot2.6 开始,你会发现用不了老版本的 Swagger 了,哎,反正迟早都得搞,那不如就今天吧!
今天我们就来看看,在 Spring Boot2.7.1 中如何使用 Swagger3。
1. 依赖
首先我们创建一个 Spring Boot 项目,引入 Swagger3 依赖,如下:
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </dependency>
以前在 Swagger2 的时代,这个依赖我们需要引入两个,现在就只需要这一个即可。
2. 配置
接下来在启动类上添加两个注解,开启 Swagger:
@SpringBootApplication //开启swagger @EnableSwagger2 @EnableOpenApi @EnableWebMvc public class SwaggerDemoApplication { public static void main(String[] args) { SpringApplication.run(SwaggerDemoApplication.class, args); } }
现在,基本工作就已经完成了,此时即使我们不做任何额外的事情,Swagger 文档也已经可以自动生成了。
启动项目,浏览器输入 http://localhost:8080/swagger-ui/index.html 查看 Swagger 文档。
小伙伴们需要注意,这个默认的文档
Spring Boot 整合 Swagger3 指南
最新推荐文章于 2024-08-20 17:25:50 发布
本文介绍了如何在Spring Boot 2.7.1中集成Swagger3,包括添加依赖、配置启动类、定制Swagger信息、接口配置和在Spring Security中的配置。通过实例展示了Swagger3的使用方法,帮助开发者生成和测试API文档。
摘要由CSDN通过智能技术生成