Linux环境下Swagger如何与Spring Boot集成

在Linux环境下，将Swagger与Spring Boot集成可以帮助你自动生成API文档，方便前后端开发人员查看和测试接口。以下是详细的步骤：

1. 添加依赖

首先，在你的Spring Boot项目的pom.xml文件中添加Swagger和Swagger UI的依赖。

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

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

    <!-- 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.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
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()
                .apiInfo(apiInfo());
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("API Documentation")
                .description("API Documentation for Spring Boot Application")
                .version("1.0.0")
                .build();
    }
}

3. 启动应用

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

./mvnw spring-boot:run

4. 访问Swagger UI

在浏览器中访问以下URL来查看Swagger UI界面：

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

5. 配置Swagger UI（可选）

如果你希望自定义Swagger UI的外观或行为，可以在配置类中进行相应的设置。例如，你可以添加自定义的CSS或JavaScript文件。

6. 测试API

在Swagger UI界面中，你可以看到所有定义的API，并可以直接在界面上进行测试。

注意事项

• 确保你的Spring Boot版本与Swagger版本兼容。
• 如果你使用的是Spring Boot 2.6及以上版本，可能需要使用springfox-boot-starter而不是springfox-swagger2和springfox-swagger-ui。
• 在生产环境中，建议禁用Swagger，以避免暴露敏感信息。

通过以上步骤，你就可以在Linux环境下成功地将Swagger与Spring Boot集成，并利用Swagger UI来管理和测试你的API。