spring boot集成swagger

### Spring Boot 整合 Swagger 实现 API 文档自动化配置 #### 添加依赖项 为了使 Spring Boot 项目能够支持 Swagger 自动生成 API 文档，在项目的 `pom.xml` 文件中需引入相应的 Maven 依赖： ```xml <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </dependency> ``` 此操作确保了 spring-boot-starter-swagger 成为 Spring Boot 生态系统的一部分，实现了与框架的无缝集成并提供快速开发能力[^1]。 #### 配置Swagger属性 接着定义 Swagger 的基本设置。可以在 application.properties 或者 application.yml 中加入如下配置来定制化 Swagger 行为: 对于 properties 文件: ```properties springdoc.api-docs.path=/v3/api-docs springdoc.swagger-ui.path=/swagger-ui.html ``` 对于 YAML 文件: ```yaml springdoc: api-docs: path: /v3/api-docs swagger-ui: path: /swagger-ui.html ``` 这些路径指定了 OpenAPI 描述文件的位置以及 Swagger UI 访问地址[^2]。 #### 创建Swagger配置类 (可选) 如果希望进一步调整 Swagger 设置，则可以创建一个新的 Java 类用于配置 Swagger 特定选项。下面是一个简单的例子展示如何通过此类启用或禁用某些特性： ```java import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; @Configuration public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.OAS_30) .select() .apis(RequestHandlerSelectors.any()) .paths(PathSelectors.any()) .build(); } } ``` 这段代码片段展示了怎样构建一个基于 OAS 3.0 规范的 Docket 对象，并将其应用于整个应用程序中的所有控制器方法上。 完成上述步骤之后，当启动 Spring Boot 应用程序时，就可以通过访问指定 URL 来查看由 Knife4j 提供的增强版 Swagger UI 页面，从而方便地管理和测试 RESTful Web Services 接口。