LinuxSwagger与SpringBoot结合使用攻略

本文提供Linux环境下Spring Boot项目集成Swagger的详细指南，旨在简化API文档的生成和测试流程。通过添加`springfox-swagger2`和`springfox-swagger-ui`依赖，并配置`SwaggerConfig`类，即可快速生成交互式API文档。文章涵盖了基础配置、高级配置（包括自定义API信息和全局参数）以及访问Swagger UI界面的步骤，帮助开发者轻松实现Spring Boot项目与Swagger的无缝集成，提升开发效率。 学习本教程，快速掌握在Linux系统下使用Swagger测试Spring Boot接口。

本文介绍如何在Spring Boot项目中集成Swagger，方便API文档的生成和测试。 以下步骤将指导您完成集成过程：

1. 添加依赖项:

在您的pom.xml文件中添加以下依赖：

io.springfoxspringfox-swagger22.9.2io.springfoxspringfox-swagger-ui2.9.2

请根据您的项目需求选择合适的版本号。

2. Swagger配置:

创建一个名为SwaggerConfig.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;
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("your.base.package")) //替换为您的控制器包名
                .paths(PathSelectors.any())
                .build();
    }
}

记住将"your.base.package"替换成您Spring Boot项目中控制器类的包名。

3. 访问Swagger UI:

启动Spring Boot应用后，在浏览器中访问以下URL：

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

您应该能够看到Swagger UI界面，其中列出了所有可用的API。

4. 高级配置 (可选):

您可以进一步自定义Swagger配置，例如添加API信息、全局参数等。以下是一个更详细的配置示例：

import springfox.documentation.builders.*;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.List;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        List params = new ArrayList<>();
        params.add(new ParameterBuilder()
                .name("Authorization")
                .description("Access token")
                .modelRef(new ModelRef("string"))
                .parameterType("header")
                .required(false)
                .build());

        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("My API")
                .description("My API description")
                .version("1.0.0")
                .contact("Your Name")
                .build();

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo)
                .select()
                .apis(RequestHandlerSelectors.basePackage("your.base.package")) //替换为您的控制器包名
                .paths(PathSelectors.any())
                .build()
                .globalOperationParameters(params);
    }
}

完成以上步骤后，您就成功将Swagger集成到Spring Boot项目中了，可以使用Swagger UI方便地浏览和测试您的API。

文中关于的知识介绍，希望对你的学习有所帮助！若是受益匪浅，那就动动鼠标收藏这篇《LinuxSwagger与SpringBoot结合使用攻略》文章吧，也可关注golang学习网公众号了解相关技术文章。