Springboot集成Swagger详解经过

Springboot集成Swagger以及配置Swagger 若看不懂，可点击此视频链接https://www.bilibili.com/video/BV1Y441197Lw 最终的依赖和代码 依赖 io.springfox springfox-swagger2 2.9.2 io.springfox springfox-swagger-ui 2.9.2 最终代码 复制粘贴 运行项目 输入http://localhost:8080/swagger-ui.html 即可看到集成与配置完成 代码 im 在本文中，我们将深入探讨如何在Spring Boot应用中集成Swagger，并详细解析集成过程及关键配置。Swagger是一款强大的API文档工具，它可以自动生成RESTful API的文档，帮助开发者更轻松地管理和测试API。以下是对Spring Boot集成Swagger的详细步骤和配置说明。 集成Swagger需要引入相应的依赖。在Maven项目中，你需要在`pom.xml`文件中添加以下依赖： ```xml <dependencies> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency> </dependencies> ``` 这两个依赖分别用于Swagger的核心功能和用户界面。版本号可能会更新，请根据最新的稳定版进行选择。 接下来，我们需要创建一个配置类来启用Swagger。创建一个名为`SwaggerConfig`的Java类，并添加`@Configuration`和`@EnableSwagger2`注解，这将开启Swagger 2的支持。代码如下： ```java import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.service.ApiInfo; import springfox.documentation.service.Contact; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket docket() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .enable(true) // 启用Swagger .select() .apis(RequestHandlerSelectors.basePackage("com.casaba.swagger.controller")) .build(); } private ApiInfo apiInfo() { Contact DEFAULT_CONTACT = new Contact("吴文霞", "https://mp.csdn.net/console/article", "1628794013@qq.com"); return new ApiInfo( "swagger接口文档", // 页面标题 "开发新型", // 描述 "1.0", // 版本 "https://www.casaba.top/index.html", // termsOfServiceUrl DEFAULT_CONTACT, // 联系人信息 "Apache 2.0", // 许可证类型 "http://www.apache.org/licenses/LICENSE-2.0", // 许可证URL new ArrayList<>()); // 版权信息 } } ``` 在上面的代码中，`docket()` 方法用于创建一个 `Docket` 实例，它定义了Swagger的基本配置。`apiInfo()` 方法用于设置API的元信息，如标题、描述、版本等。`select().apis(RequestHandlerSelectors.basePackage("com.casaba.swagger.controller")).build();` 这行代码告诉Swagger扫描哪个包下的控制器类来生成API文档。 完成上述配置后，运行你的Spring Boot应用。然后，通过浏览器访问 `http://localhost:8080/swagger-ui.html`，你就可以看到Swagger UI界面，它展示了你的API接口及其详细信息。 通过Swagger，你可以直观地查看API接口的HTTP方法、请求路径、参数、响应等信息。此外，Swagger还提供了一个交互式的测试环境，允许开发者直接在界面上发送请求并查看响应，极大地提高了API开发和调试的效率。 Spring Boot与Swagger的集成使得API的管理、文档编写和测试变得更加便捷。通过适当的配置，你可以定制化Swagger来满足项目的具体需求，提供高质量的API文档。在实际开发中，确保始终更新依赖库到最新版本，以获取最新的特性和修复。