springboot2使用swagger3

### 集成和使用 Swagger 3 的教程 为了在 Spring Boot 2 中集成和使用 Swagger 3，可以按照以下方法操作： #### 1. 添加依赖项 首先，在 `pom.xml` 文件中添加所需的 Maven 依赖项来支持 Swagger 和 OpenAPI 3.x 版本。 ```xml <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </dependency> ``` 此依赖项会自动配置许多必要的组件以支持 Swagger UI 和 OpenAPI 文档生成[^1]。 #### 2. 启用 Swagger 支持 通过创建一个 Java 配置类并定义 `Docket` Bean 来启用 Swagger 功能。这是 Swagger 主要围绕的核心部分[^3]。 ```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) // 使用 OAS 3.0 (OpenAPI 3) .select() .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller")) // 替换为实际的包路径 .paths(PathSelectors.any()) .build(); } } ``` 在此代码片段中，指定了文档类型为 `OAS_30` 表示我们正在使用 OpenAPI 3.0 标准。 #### 3. 创建 Spring Boot 应用程序 如果尚未创建 Spring Boot 项目，则可以通过访问 [Spring Initializr](https://start.spring.io/) 并选择所需选项快速构建应用程序[^2]。确保选择了 Web 开发相关的依赖项（如 Spring Web），以便能够运行 RESTful API。 #### 4. 访问 Swagger UI 页面 完成上述步骤后，启动 Spring Boot 应用程序，并打开浏览器访问地址： `http://localhost:8080/swagger-ui/index.html#/` 这将显示完整的交互式 API 文档界面，允许测试端点功能以及查看请求/响应结构。 --- ### 注意事项 - 如果不使用 Spring Boot 而是其他类型的 Spring 项目，则可能需要额外调整某些设置才能正常工作。 - 确保所使用的版本兼容性良好；例如，Spring Boot 2.x 及其对应的 SpringFox 或其他工具库应保持一致。 ---