SpringMVC集成swagger时访问配置

最新推荐文章于 2025-11-11 07:15:00 发布

原创最新推荐文章于 2025-11-11 07:15:00 发布 · 896 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#swagger #spring #java

JAVA 同时被 2 个专栏收录

12 篇文章

订阅专栏

服务器

4 篇文章

订阅专栏

本文详细介绍如何在项目中配置Swagger，包括在index.html中设置访问地址，spring-mvc.xml中的组件扫描与资源映射，以及SwaggerConfig配置文件的编写，实现API文档的自动生成与在线预览。

1、swagger下的index.html中配置访问地址：

var url = window.location.search.match(/url=([^&]+)/);
if (url && url.length > 1) {
url = decodeURIComponent(url[1]);
} else {
url = "/rest/v2/api-docs";
}

2、配置文件：spring-mvc.xml里面配置

<context:component-scan base-package="springfox"/>
<bean class="com.itjava.swagger.SwaggerConfig" />
<mvc:resources mapping="/swagger/**" location="/swagger/" cache-period="31556926" />

3、写配置文件：SwaggerConfig

@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.pathMapping("/rest/")//对请求的路径增加rest前缀
.globalOperationParameters(setHeaderToken())
.select()
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)) //只过滤包含有ApiOperation注解的方法
.paths(PathSelectors.any()) //对所有的路径进行监控
.build();
}

4、如此配置，访问地址：http://localhost:8080/swagger/index.html