SpringBoot集成Swagger4

Swagger是一种工具，可以帮助开发人员设计、构建、文档化和测试 RESTful Web 服务。Swagger提供了一种交互式文档格式，可以使用它来了解 API 的用法、参数、返回值等等。

Spring Boot提供了集成Swagger的简单方式。在本文中，我们将介绍如何在Spring Boot项目中集成Swagger 4。

步骤1：添加Swagger 4依赖

在pom.xml文件中添加Swagger 4的依赖：

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>4.0.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>4.0.0</version>
</dependency>

这些依赖将提供Swagger 4的核心库和UI库。

步骤2：创建Swagger配置类

在Spring Boot项目中，我们可以通过创建一个Swagger配置类来配置Swagger。

创建一个名为SwaggerConfig的Java类，并添加以下代码：

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }
}

@EnableSwagger2注解启用Swagger 4，并@Bean注解创建Docket实例。Docket是Swagger的主配置类，它可以配置Swagger的各种属性，例如文档类型、API选择、API路径等等。

上面的代码配置了API选择和API路径，使Swagger能够自动检测项目中的所有API并生成文档。

步骤3：运行应用程序并访问Swagger UI

现在，启动您的Spring Boot应用程序，并访问以下URL：

http://localhost:8080/swagger-ui/index.html

您应该会看到一个类似于下面的Swagger UI页面：

在Swagger UI中，您可以查看您的API文档，并使用Swagger的交互式界面测试您的API。

总结

在本文中，我们介绍了如何在Spring Boot项目中集成Swagger 4。我们添加了Swagger 4的依赖，并创建了一个Swagger配置类来配置Swagger。最后，我们运行应用程序并访问Swagger UI来查看API文档。