Spring 4.2.2以上版本和swagger集成方案和踩过的坑

因为公司使用的spring版本太高，在集成swagger的时候会存在一些问题，而网上的很多实例大多都是版本比较低的，为了是朋友们少才坑，我这边将集成的过程记录一下：

1. 引入spring、swagger的相关jar包（springfox-swagger2、springfox-swagger-ui），在pom.xml中配置：

            io.springfox
            springfox-swagger2
            2.4.0
            
                
                    org.springframework
                    spring-core
                
                
                    org.springframework
                    spring-beans
                
                
                    org.springframework
                    spring-context
                
                
                    org.springframework
                    spring-context-support
                
                
                    org.springframework
                    spring-aop
                
                
                    org.springframework
                    spring-tx
                
                
                    org.springframework
                    spring-orm
                
                
                    org.springframework
                    spring-jdbc
                
                
                    org.springframework
                    spring-web
                
                
                    org.springframework
                    spring-webmvc
                
                
                    org.springframework
                    spring-oxm
                
            
        
        
            io.springfox
            springfox-swagger-ui
            2.4.0
        

提醒： 特别注意，springfox-swagger2在集成的时候，已经引入了spring的相关jar，特别是spring-context、spring-context-support的版本和项目中使用的版本完全不一致，项目在启动的时候出现很多包冲突的问题，这边在引入pom.xml文件的时候过滤掉了spring的相关jar包，如绿色标志。

1. 编写Swagger的配置类：

package com.ml.honghu.swagger.web;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;

import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@EnableWebMvc
@EnableSwagger2
@Configuration
@ComponentScan(basePackages ={"com.ml.honghu.**.rest"})
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.ml.honghu"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("接口列表 v1.0")
                .description("接口信息")
                .termsOfServiceUrl("http://honghu.com")
                .contact(new Contact("", "", "HongHu"))
                .version("1.1.0")
                .build();
    }
}

提醒：注意红色标注的地方

1. 在spring-mvc.xml文件中进行过滤器的配置，过滤掉swagger的相关访问配置：

1. 服务配置项

1.  @Api("区域服务") 
2.  @RestController 
3.  @RequestMapping(value = "/rest/area") 
4.  public class AreaService  { 

6.   @Autowired 
7.   private AreaService areaService; 

9.   @ApiOperation(value = "区域列表", httpMethod = "GET", notes = "区域列表") 
10.   @IsLogin 
11.   @ResponseBody 
12.   @RequestMapping(value = "treeData", method = RequestMethod.GET) 
13.   public List> treeData( 
14.   @ApiParam(required = true, value = "区域ID") @RequestParam(required=false) String extId, HttpServletResponse response) { 
15.   List> mapList = Lists.newArrayList(); 
16.   List list = areaService.findAll(); 
17.   for (int i=0; i map = Maps.newHashMap(); 
21.   map.put("id", e.getId()); 
22.   map.put("pId", e.getParentId()); 
23.   map.put("name", e.getName()); 
24.   mapList.add(map); 
25.   } 
26.   } 
27.   return mapList; 
28.   } 
29.  }

1. 启动项目，查看结果：

 

到此结束！！（企业架构源码可以加求球：叁五三陆二肆柒二伍玖）