Swagger 报错分析与解决方案
Swagger 是一个强大的 API 文档生成工具，广泛应用于前后端分离的项目中，在实际使用过程中，开发者可能会遇到各种报错问题，本文将详细分析一些常见的 Swagger 报错及其解决方法，并附上相关问答FAQs。
常见 Swagger 报错及解决方法
（图片来源网络，侵权删除）
| 错误信息 | 原因分析 | 解决方法 |
Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException | SPRingfox 使用的路径匹配是基于 AntPathMatcher，而 Spring Boot 2.6.X 使用的是 PathPatternMatcher。 | 1. 在该配置类上添加注解：@EnableWebMvc 来改变匹配规则。2. 在 application.yaml 或 application.properties 文件中添加该语句： spring.mvc.pathmatch.matchingstrategy=ant_path_matcher 来改变匹配规则。3. 降低 Swagger 的版本到 2.5.* 版本即可。 |
This application has no explicit mapping for /error, so you are seeing this as a fallback... | IDEA 的目录结构出现问题，SpringApplication 的启动类应该在最外层，包含所有子包。 | 确保 SpringApplication 的启动类在最外层，包含所有子包。 |
| Swagger 访问地址报错 404 | 可能是因为当前环境拦截了 Swagger 默认的静态资源。 | 实现 WebMvcConfigurer 接口并重写 addResourceHandlers 方法，确保 Swagger 的资源路径被允许匿名访问。 |
| Swagger 依赖冲突 | 引入 Swagger 相关依赖后，可能会出现依赖冲突。 | 检查项目中的依赖，确保没有重复或冲突的 Swagger 依赖，可以使用 Maven 的依赖树命令（mvn dependency:tree）来查看项目的依赖关系。 |
| Swagger 配置文件错误或不完整 | Swagger 的配置文件可能存在错误或不完整。 | 检查 Swagger 的配置文件（通常是 application.yml 或 application.properties），确保所有必要的配置都已正确设置，确保springfox.documentation.swagger.v2.path 配置正确指定了 Swagger 的根路径。 |
| Swagger 与 Spring 版本不兼容 | 使用的 Swagger 版本与 Spring Boot 版本不兼容。 | 检查使用的 Swagger 版本是否与 Spring Boot 版本兼容，如果不确定，可以查阅 Swagger 的官方文档或相关社区资源，找到与当前 Spring Boot 版本兼容的 Swagger 版本。 |
| Swagger 传递 Date 类型参数时报错 400 Bad Request | Swagger 在处理特殊类型参数（如 Date）时，可能存在序列化或格式化问题。 | 确保 Swagger 调用时使用正确的日期格式，避免传递字符串形式的日期，可以通过 Postman 进行调试，确认接口逻辑没有问题。 |
相关问答 FAQs
Q1: Swagger 无法启动，报错Failed to start bean 'documentationPluginsBootstrapper'，如何解决？
A1: 这个错误通常是由于 Springfox 使用的路径匹配器与 Spring Boot 版本不兼容造成的，解决方法包括：
1、在该配置类上添加注解@EnableWebMvc 来改变匹配规则。
2、在 application.yaml 或 application.properties 文件中添加spring.mvc.pathmatch.matchingstrategy=ant_path_matcher。
3、降低 Swagger 的版本到 2.5.* 版本。
（图片来源网络，侵权删除）
Q2: Swagger UI 访问地址报错 404，如何解决？
A2: 这个错误可能是由于当前环境拦截了 Swagger 默认的静态资源，解决方法是实现 WebMvcConfigurer 接口并重写 addResourceHandlers 方法，确保 Swagger 的资源路径被允许匿名访问，具体代码如下：
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/swaggerui/**")
.addResourceLocations("classpath:/METAINF/resources/webjars/springfoxswaggerui/");
registry.addResourceHandler("/swaggerui.html").addResourceLocations("classpath:/METAINF/resources/");
registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/METAINF/resources/");
registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/METAINF/resources/webjars/");
}
}Swagger 是一个功能强大的工具，但在使用时可能会遇到各种报错问题，通过分析错误信息，查找原因并采取相应的解决方法，可以有效地解决这些问题，提高开发效率。
（图片来源网络，侵权删除）
