swagger2与spring的整合_swagger2+spring-优快云博客

本文详细介绍如何在SpringBoot项目中集成Swagger2，包括添加依赖、配置Swagger2Config类及修改springmvc-servlet.xml文件，实现API文档自动生成。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1 添加如下依赖：

<dependency>  
<groupId>io.springfox</groupId>  
<artifactId>springfox-swagger2</artifactId>  
<version>2.5.0</version>  
</dependency>  
<dependency>  
<groupId>io.springfox</groupId>  
<artifactId>springfox-swagger-ui</artifactId>  
<version>2.5.0</version>  
</dependency>

2 增加Swagger2Config配置类，只显示使用@Api注解的api。

@Component  
@Configuration  
@EnableSwagger2  
@EnableWebMvc  
@ComponentScan(basePackageClasses = QuartzManagerAction.class)  
public class Swagger2Config {  
@Bean  
public Docket createAPI() {  
return new Docket(DocumentationType.SWAGGER_2)  
.apiInfo(apiInfo())  
.select()  
.apis(RequestHandlerSelectors.withClassAnnotation(Api.class))  
.paths(PathSelectors.any())  
.build();  
}  
private ApiInfo apiInfo() {  
Contact contact = new Contact("lfw", "http://lfwer.iteye.com", "lfwer@163.com");  
ApiInfo apiInfo = new ApiInfoBuilder().license("Apache License Version 2.0").title("定向流量系统").description("Swagger API").contact(contact).version("1.0").build();  
return apiInfo;  
}  
}

3 修改springmvc-servlet.xml，增加swagger静态资源文件路径配置

<mvc:resources location="classpath:/META-INF/resources/" mapping="swagger-ui.html"/>  
<mvc:resources location="classpath:/META-INF/resources/webjars/" mapping="/webjars/**"/>