Linux下Swagger如何与Spring Boot集成

在Linux环境下，将Swagger与Spring Boot集成可以帮助你创建、测试和文档化你的RESTful API。以下是集成Swagger与Spring Boot的步骤：

1. 添加依赖

首先，在你的pom.xml文件中添加Swagger和Springfox的依赖。Springfox是一个用于生成Swagger文档的库。

<dependencies>
    <!-- Spring Boot Starter Web -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!-- Springfox Swagger2 -->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.9.2</version>
    </dependency>

    <!-- Springfox Swagger UI -->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.9.2</version>
    </dependency>
</dependencies>

2. 配置Swagger

创建一个配置类来配置Swagger。

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;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller")) // 替换为你的控制器包路径
                .paths(PathSelectors.any())
                .build();
    }
}

3. 启动应用

确保你的Spring Boot应用已经启动。你可以使用以下命令来启动应用：

./mvnw spring-boot:run

4. 访问Swagger UI

一旦应用启动，你可以通过浏览器访问Swagger UI。默认情况下，Swagger UI的地址是：

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

5. 测试API

在Swagger UI中，你可以看到你的API列表，并且可以测试每个API。你可以在Swagger UI中输入请求参数，发送请求并查看响应。

注意事项

• 确保你的Spring Boot版本与Springfox版本兼容。
• 如果你使用的是Spring Boot 3.x，Springfox可能不兼容。你可以考虑使用SpringDoc OpenAPI，它是Springfox的一个替代品，支持Spring Boot 3.x。

使用SpringDoc OpenAPI（可选）

如果你需要支持Spring Boot 3.x，可以考虑使用SpringDoc OpenAPI。以下是集成步骤：

添加依赖

在pom.xml中添加SpringDoc OpenAPI的依赖：

<dependencies>
    <!-- Spring Boot Starter Web -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!-- SpringDoc OpenAPI -->
    <dependency>
        <groupId>org.springdoc</groupId>
        <artifactId>springdoc-openapi-ui</artifactId>
        <version>1.6.9</version>
    </dependency>
</dependencies>

配置SpringDoc OpenAPI

SpringDoc OpenAPI不需要额外的配置类，它会自动扫描你的控制器并生成Swagger文档。

启动应用

使用以下命令启动应用：

./mvnw spring-boot:run

访问Swagger UI

访问Swagger UI的地址：

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

通过以上步骤，你可以在Linux环境下成功集成Swagger与Spring Boot，并使用Swagger UI来测试和文档化你的API。