### 如何在
Spring MVC 中配置
静态资源映射以支持 Swagger
为了使
Spring MVC 支持 Swagger 的功能，除了需要引入必要的依赖外，还需要正确配置
静态资源映射以便能够访问 Swagger UI 页面及其相关资源。以下是具体的实现方法：
#### 1. 添加 Maven 依赖
确保项目的 `pom.xml` 文件中包含了 Swagger 和
Spring MVC 所需的依赖项。
```xml
<dependency>
<groupId>io.
springfox</groupId>
<artifactId>
springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.
springfox</groupId>
<artifactId>
springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
```
这些依赖会帮助加载 Swagger 功能以及其前端界面所需的静态文件[^1]。
---
#### 2. 创建 Docket Bean 配置类
通过定义一个配置类来初始化和
设置 Swagger 的核心组件——Docket Bean。
```
java
import org.
springframework.context.annotation.Bean;
import org.
springframework.context.annotation.Configuration;
import
springfox.documentation.builders.PathSelectors;
import
springfox.documentation.builders.RequestHandlerSelectors;
import
springfox.documentation.spi.DocumentationType;
import
springfox.documentation.
spring.web.plugins.Docket;
@Configuration
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("com.example.controller")) // 替换为实际 Controller 包路径
.paths(PathSelectors.any())
.build();
}
}
```
上述代码片段展示了如何创建一个用于启用 Swagger 文档生成功能的 Docket 实例，并指定 API 接口所在的包名。
---
#### 3. 配置
静态资源映射
为了让浏览器可以正常加载 Swagger UI 的 HTML、CSS 和
JavaScript 文件，必须显式声明对这些
静态资源的支持。可以通过重写 Web
MvcConfigurer 的 `addResourceHandlers` 方法完成此操作。
```
java
import org.
springframework.context.annotation.Configuration;
import org.
springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.
springframework.web.servlet.config.annotation.Web
MvcConfigurer;
@Configuration
public class WebConfig implements Web
MvcConfigurer {
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
//
映射 Swagger UI 的
静态资源
registry.addResourceHandler("/swagger-ui/**")
.addResourceLocations("classpath:/META-INF/resources/webjars/
springfox-swagger-ui/");
// 如果存在其他自定义
静态资源目录，则继续添加处理规则
registry.addResourceHandler("/static/**")
.addResourceLocations("classpath:/static/");
}
}
```
这段代码的作用是告诉
Spring MVC 将 `/swagger-ui/**` 请求转发到对应的
静态资源位置，从而允许客户端顺利获取 Swagger UI 界面所需的内容[^3]。
---
#### 4. 启动应用并测试
启动应用程序后，在浏览器地址栏输入如下 URL 即可查看 Swagger UI 界面：
```
http://localhost:8080/swagger-ui/index.html
```
如果一切配置无误，应该可以看到完整的接口文档页面。
---
### 注意事项
- **版本兼容性**：确保使用的
Spring Boot 或
Spring MVC 版本与 Swagger 库版本相匹配，以免因不兼容而导致错误。
- **安全性考量**：生产环境中建议关闭或限制对外暴露的 Swagger 访问权限，防止敏感信息泄露。
---
扫一扫
1164
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
