Swagger 详解：从介绍到配置及常见问题解决

一、配置

<!-- 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>

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 createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                // 扫描指定包下的接口
                .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
                // 扫描所有接口
                //.apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("API文档")
                .description("这是一个Spring Boot项目的API文档")
                .version("1.0.0")
                .build();
    }
}

二、配置后不生效

1.配置里添加为白名单
- /v3/api-docs/**
- /swagger-ui/**
- /swagger-ui.html

2.本地文件上传：

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        /** 本地文件上传路径 */
        registry.addResourceHandler(Constants.RESOURCE_PREFIX + "/**","/swagger-ui/**")
            .addResourceLocations("file:" + RuoYiFileConfig.getProfile() + "/")
            .addResourceLocations("classpath:/META-INF/resources/webjars/swagger-ui/5.13.0/");;
    }

三、访问地址

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