###
Swagger 不
显示接口的原因分析
Swagger 不
显示接口可能由多种原因引起，以下是常见的几种情况及其解决方案：
#### 1. **Spring Boot 和
Swagger 版本不匹配**
如果 Spring Boot 和
Swagger 的版本不兼容，则可能导致
接口无法正常加载。例如，在某些情况下，高版本的 Spring Boot 可能会与低版本的
Swagger 发生冲突[^1]。
解决方法：
确认当前使用的 Spring Boot 和
Swagger 版本是否兼容，并根据官方文档调整依赖版本。可以参考以下 Maven 配置作为示例：
```xml
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
```
---
#### 2. **Controller 路径不在扫描范围内**
Swagger 默认只会扫描指定包路径下的 Controller
接口。如果
新增模块的 Controller 所在路径未被包含在扫描范围中，则这些
接口不会
显示[^4]。
解决方法：
修改 `Docket` 配置类中的扫描路径，确保覆盖所有需要展示的
模块。例如：
```
java
@Bean
public Docket api() {
return new Docket(DocumentationType.
SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("com.example")) //
修改为实际包路径
.paths(PathSelectors.any())
.build();
}
```
---
#### 3. **缺少必要的注解**
Swagger 显示接口的前提条件之一是 Controller 方法上需有相应的注解（如 `@Api`, `@ApiOperation`）。如果没有正确添加这些注解，
Swagger 将忽略该
接口。
解决方法：
确保每个 Controller 类和方法都加上了合适的注解。例如：
```
java
@RestController
@RequestMapping("/example")
@Api(tags = "Example API") // 添加 Api 注解
public class ExampleController {
@GetMapping("/test")
@ApiOperation(value = "测试
接口", notes = "这是一个简单的 GET 请求") // 添加 Operation 注解
public String test() {
return "Hello, World!";
}
}
```
---
#### 4. **静态资源配置缺失**
部分场景下，
Swagger 文档页面可能因为静态资源映射
问题而无法正常渲染
接口信息。这通常发生在微服务架构中的一些特殊
模块[^3]。
解决方法：
创建一个自定义的 `WebMvcConfigurer` 配置类来补充静态资源映射。例如：
```
java
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/**").addResourceLocations(
"classpath:/META-INF/resources/",
"classpath:/resources/",
"classpath:/static/");
}
}
```
---
#### 5. **排除特定
模块的
接口**
在一些框架（如 RuoYi 微服务）中，默认可能会通过配置文件或代码逻辑屏蔽掉某些
模块的
接口文档生成[^5]。
解决方法：
检查是否存在类似的过滤器配置，例如 `
SwaggerProvider.
java` 中是否有针对
模块名称的筛选规则。如果有需求保留某
模块的
接口文档，则应移除相关限制。
---
#### 6. **其他潜在因素**
- 如果项目中有多个 Profile 或环境切换机制，可能存在不同环境下
Swagger 功能启用状态不同的情况。
- 检查日志输出，寻找更详细的错误提示以便定位
问题根源。
---
### 总结
以上列举了几种常见导致
Swagger 不
显示接口的原因以及对应的处理方式。建议逐一排查上述可能性并结合实际情况采取措施解决
问题。
扫一扫
6286
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
