SpringBoot集成Swagger2配置及出现的问题记录

最新推荐文章于 2023-10-25 22:03:37 发布

原创最新推荐文章于 2023-10-25 22:03:37 发布 · 422 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#springboot #swagger

swagger 专栏收录该内容

1 篇文章

订阅专栏

博客介绍了Spring Boot集成Swagger的相关内容，包括依赖添加、配置（如yml、swagger config等），还提到要对拦截器或filter给swagger页面放行。同时指出可能出现的问题，如swagger页面404等，并给出解决方案，如自定义静态资源映射目录。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

点击跳转至我的个人网站 https://www.xiaoshenghao.cn

一. 依赖

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.8.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.8.0</version>
</dependency>

二.配置

yml

swagger.enable: true #swagger是否生效，生产环境记得禁用

swagger config

@Configuration
@ConditionalOnProperty(prefix = "swagger", value = {"enable"}, havingValue = "true")
@EnableSwagger2
public class Swagger2Config {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.myBlog.web.controller"))
                .paths(PathSelectors.any())
                .build()
                .securitySchemes(securitySchemes())
                .securityContexts(securityContexts())
                ;
    }

    private ApiInfo apiInfo() {
        Contact contact = new Contact("技术部", "", "");
        return new ApiInfoBuilder()
                .title("我的博客接口文档")
                .description("我的博客接口文档")
                .version("1.0")
                .contact(contact)
                .build();
    }

    private List<ApiKey> securitySchemes() {
        List<ApiKey> arrayList = new ArrayList<>();
        arrayList.add(new ApiKey("Authorization", "token", "header"));
        return arrayList;
    }

    private List<SecurityContext> securityContexts() {
        List<SecurityContext> arrayList = new ArrayList<>();
        arrayList.add(SecurityContext.builder()
                .securityReferences(defaultAuth())
                .build());
        return arrayList;
    }

    private List<SecurityReference> defaultAuth() {
        AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
        AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
        authorizationScopes[0] = authorizationScope;
        List<SecurityReference> arrayList = new ArrayList<>();
        arrayList.add(new SecurityReference("Authorization", authorizationScopes));
        return arrayList;
    }

拦截器或filter给swagger页面放行

三.可能出现的问题

1.swagger页面404或者拦截器进入/error路径

解决方案

自定义静态资源映射目录，addResoureHandler指的是对外暴露的访问路径，addResourceLocations指的是文件放置的目录

@Configuration
public class WebConfig implements WebMvcConfigurer{
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");
                registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
    }

特别注意：
如果你的项目中使用了 extends WebMvcConfigurationSupport，swagger自动配置失效，必然会出现以上情况。只需要在你的项目中继承WebMvcConfigurationSupport的子类中加上：

   @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
        super.addResourceHandlers(registry);
    }