一文读懂Spring Boot不同模块下Knife4j文档请求异常背后的隐秘

后端

2022-11-21 17:13:27

Spring Boot：Knife4j 文档请求异常的终极指南

什么是 Knife4j 文档请求异常？

Knife4j 是一款功能强大的 API 文档生成工具，可帮助您轻松创建清晰简洁的 API 文档。然而，在使用 Knife4j 时，您可能会遇到文档请求异常。这些异常通常源于以下原因：

未正确配置 WebMvcConfig 注解
白名单设置不当

如何解决 Knife4j 文档请求异常？

1. 检查 WebMvcConfig 注解的配置

在 Spring Boot 项目中，WebMvcConfig 注解应添加到启动类中。将其添加到其他模块中会导致异常。

2. 检查白名单设置

Knife4j 需要对某些 URL 放行才能访问 API 文档。未正确设置白名单会引发异常。

WebMvcConfig 注解配置示例：

@SpringBootApplication
@EnableSwagger2
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

    @Bean
    public WebMvcConfig webMvcConfig() {
        return new WebMvcConfig();
    }
}

白名单设置示例：

public class WebMvcConfig implements WebMvcConfigurer {

    @Override
    public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/**")
                .allowedOrigins("*")
                .allowedMethods("GET", "POST", "PUT", "DELETE")
                .allowedHeaders("*")
                .maxAge(3600);
    }
}