在使用 IntelliJ
IDEA 进行
Java 开发时，若
新建模块后发现 Swagger 未显示对应的接口信息，通常涉及以下几个方面的问题和解决方法：
### 1. 检查模块是否正确集成 Swagger
确保
新建的模块中已经正确
引入了 Swagger 依赖，并且配置
类（如 `SwaggerConfig`）已正确启用 Swagger 支持。例如，在使用 Spring Boot 和 Springdoc OpenAPI（Swagger3）时，应确保 `pom.xml` 或 `build.gradle` 文件中
包含以下
Maven 依赖：
```xml
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>2.6.0</version>
</dependency>
```
同时，确保配置
类中通过 `@Configuration` 注解启用了 Swagger，并正确配置了 OpenAPI 信息 [^4]。
### 2. 检查接口所在的
包是否被扫描
Spring Boot 默认只会扫描主应用程序
类所在
包及其子
包中的组件。如果
新建模块的
包结构未被
包含在扫描范围内，需要显式配置组件扫描路径。例如，在主应用程序
类上添加 `@ComponentScan` 注解：
```
java
@SpringBootApplication
@ComponentScan(basePackages = {"com.example.mainapp", "com.example.new
module"})
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
```
确保
新建模块的控制器
类所在的
包位于扫描路径中，否则 Swagger 无法检测到这些接口 [^4]。
### 3. 检查控制器
类和方法的注解
确保
新建模块中的控制器
类和方法使用了正确的注解。例如，使用 `@RestController` 标记控制器
类，并在每个接口方法上使用 `@Operation` 注解描述其功能：
```
java
@Tag(name = "TestController", description = "测试接口")
@RestController
@RequestMapping("/test")
public class TestController {
@Operation(summary = "获取测试信息", description = "返回测试字符串")
@GetMapping("/info")
public String getTestInfo() {
return "Test Info";
}
}
```
如果缺少必要的注解，Swagger 将无法识别这些接口 [^4]。
### 4. 检查 Swagger 的访问路径
确保访问 Swagger UI 的路径正确。在 Springdoc OpenAPI（Swagger3）中，默认访问路径为 `/swagger-ui.html`。例如，如果应用运行在本地，可以通过以下 URL 访问接口文档：
```
http://localhost:8080/swagger-ui.html
```
如果在 `application.yml` 或 `application.properties` 中自定义了 Swagger 的路径，需确保路径配置正确：
```yaml
springdoc:
swagger-ui:
path: /swagger-ui.html
```
若路径配置错误，将导致无法访问接口文档 [^4]。
### 5. 检查模块是否被正确加载
在 IntelliJ
IDEA 中，确保
新建的模块已被正确添加到项目中，并且在运行配置中被
包含。例如，在 `pom.xml` 中确认模块已被正确引用：
```xml
<
modules>
<
module>main-app</
module>
<
module>new-
module</
module>
</
modules>
```
如果模块未被正确加载，Spring Boot 无法识别其中的接口，导致 Swagger 无法显示相关信息 [^4]。
### 6. 检查 Swagger 的启用配置
确保在 `application.yml` 或 `application.properties` 中启用了 Swagger。例如，在 Springdoc OpenAPI 中，需确保配置中
包含以下内容：
```yaml
springdoc:
swagger-ui:
enabled: true
```
如果该配置被设置为 `false`，Swagger UI 将被禁用，导致接口文档无法显示 [^4]。
### 7. 重新构建并重启项目
在完成上述检查后，重新构建并重启项目以确保所有配置生效。可以通过以下命令重新构建项目：
```bash
mvn clean install
```
然后运行主应用程序
类，确保
新建模块的接口被正确加载并注册到 Swagger 中 [^4]。
---
扫一扫
1251
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
