SpringMVC集成Swagger实例代码

本篇文章主要介绍了SpringMVC集成Swagger实例代码，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧

此前写过一个关于SpringBoot集成Swagger的帖子，因为有的项目是SpringMVC的，所以也简单整理了一下，基本一致。

本例使用的是spring 4.1.6版本

1、添加POM依赖

  com.fasterxml.jackson.corejackson-core2.5.3 com.fasterxml.jackson.corejackson-annotations2.5.3 com.fasterxml.jackson.corejackson-databind2.5.3 io.springfoxspringfox-swagger22.6.1 io.springfoxspringfox-swagger-ui2.6.1

2、添加SwaggerConfig.java类

 package com.shanhy.demo.config; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.web.bind.annotation.ResponseBody; import org.springframework.web.bind.annotation.RestController; import com.google.common.base.Predicate; import springfox.documentation.RequestHandler; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.service.ApiInfo; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; @Configuration // 该注解就是告诉Spring这个是一个配置文件类，这里配置的Bean要交给Spring去管理。这个就是用来取代Beans.xml这种文件的。 @EnableSwagger2 // 启用 Swagger public class SwaggerConfig { @Bean public Docket createRestApi() { Predicate predicate = new Predicate() { @Override public boolean apply(RequestHandler input) { Class declaringClass = input.declaringClass(); // if (declaringClass == BasicErrorController.class)// 排除 // return false; if (declaringClass.isAnnotationPresent(RestController.class)) // 被注解的类 return true; if (input.isAnnotatedWith(ResponseBody.class)) // 被注解的方法 return true; return false; } }; return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()) // .genericModelSubstitutes(DeferredResult.class) // .genericModelSubstitutes(ResponseEntity.class) .useDefaultResponseMessages(false) // .forCodeGeneration(false) .select().apis(predicate) // .paths(PathSelectors.any())//过滤的接口 .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder().title("接口服务")// 大标题 .version("1.0")// 版本 .build(); } }

3、配置文件添加

    ...... ...... ...... ......

4、测试Controller方法

 @Controller public class HomeController { @RequestMapping(value = "/test", method = RequestMethod.GET) @ResponseBody public String test(Locale locale, Model model) { return "test"; } }

5、启动服务访问查看效果

访问地址：http://localhost:8188/{工程contextPath}/swagger-ui.html