SpringBoot项目整合swagger

1.添加swagger依赖

<!--swagger相关依赖--> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.7.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.7.0</version> </dependency>

2.编写开启swagger的方法(2选1)

 注意：如果你的application.properties中有静态文件访问配置（如：spring.mvc.static-path-pattern=/static/**），需要删除该配置，然后开启swagger的方法继承WebMvcConfigurationSupport类，重写addResourceHandlers()方法，给静态资源请求添加映射，将路径中包括/static/的静态资源访问映射到resources/static/目录下，因为swagger与静态文件访问配置冲突，要换种方式访问静态文件。代码如下：

import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.service.ApiInfo; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; @Configuration @EnableSwagger2 public class Swagger2Config extends WebMvcConfigurationSupport { @Override public void addResourceHandlers(ResourceHandlerRegistry registry) { registry.addResourceHandler("swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/"); // springboot 集成swagger2.2后静态资源404，添加如下两行配置 registry.addResourceHandler("/static/**").addResourceLocations("classpath:/static/"); registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/"); super.addResourceHandlers(registry); } @Bean public Docket customDocket() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.xq.yexiong.controller")) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("yexiong的API接口") .version("1.0") .build(); } }

否则可以直接用下面的代码：

import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.service.ApiInfo; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; @Configuration // 必须存在 @EnableSwagger2 public class Swagger2Config { @Bean public Docket customDocket() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.xq.yexiong.controller")) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder().title("yexiong的API接口").version("1.0").build(); } }

3.访问swagger

访问链接：http://localhost:27001/swagger-ui.html 

结果如下：

 参考链接：swagger 介绍及两种使用方法

                   SpringBoot 静态资源访问与Swagger-ui.html访问冲突

                   spring boot 加入拦截器后swagger不能访问问题

欢迎探讨！