Swagger常用配置

原创已于 2024-08-07 04:29:08 修改 · 3.6k 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot #spring #java

于 2022-06-13 17:36:11 首次发布

本文介绍了如何在SpringBoot项目中整合Swagger，包括引入相关依赖、配置启动及访问Swagger UI。详细讲解了Swagger的基本信息、接口、实体类和分组设置，并展示了如何通过注解进行接口和实体类的文档说明。此外，还讨论了如何根据环境控制Swagger的启动，以及如何进行分组管理，便于团队协同开发。最后，文章提到了Swagger的在线测试功能及其在文档更新和接口保护方面的重要性。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Swagger官网:swagger.io

Springboot整合Swagger 原先用的2.7报错，自己这里降成2.4.5

引入spring web

引入Swagger2和SwaggerUI依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-boot-starter -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>3.0.0</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>3.0.0</version>
</dependency>

配置下

注意将SpringBoot版本降低原先用的2.7报错，自己这里降成2.4.5

@EnableSwagger2或者@EnableOpenApi 都可以开启swagger 或许里面有很多故事