(spring swagger) SpringBoot中使用Swagger的最全方法详解 Spring Boot结合Swagger自动生成API文档全网首发(图文详解1)

(spring swagger) SpringBoot中使用Swagger的最全方法详解

Spring Boot结合Swagger可以非常方便地自动生成API文档，这对于API的测试和前后端的协同工作都非常有帮助。以下是在Spring Boot项目中整合Swagger的一个详细步骤及配置方法。

1. 添加依赖

首先，你需要在你的pom.xml中添加Swagger的相关依赖。这里以Spring Boot 2.x版本和Swagger 3.x为例：

<!-- SpringFox的依赖，适用于Swagger 3.x -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

确保选择合适的版本，适应你的Spring Boot项目。

2. 配置Swagger

然后，你需要创建一个配置类来启用Swagger UI，并提供了一些基本的配置信息。

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 apiDocket() { 
        return new Docket(DocumentationType.SWAGGER_2)  
          .select()                                  
          .apis(RequestHandlerSelectors.any())              
          .paths(PathSelectors.any())                          
          .build();                                           
    }
}

这个配置类的作用是创建一个Docket对象，它是Swagger配置的主要方式。我们在这个示例中将基本扫描所有的controllers。

3. 自定义Swagger信息

对于一些高级的定制化需求，比如修改API文档的标题、描述或者是联系人信息，可以进一步配置Docket对象。

import springfox.documentation.service.Contact;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.builders.ApiInfoBuilder;

@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
            .paths(PathSelectors.any())
            .build();
}

private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            .title("Example API Title")
            .description("API Description")
            .termsOfServiceUrl("http://example.com/terms/")
            .contact(new Contact("Name", "www.example.com", "email@example.com"))
            .version("1.0")
            .build();
}