四步五分钟Spring4快速集成Swagger

 更新时间:2017年12月10日 13:34:20   转载 作者:一个有点理想的猿  
这篇文章主要为大家详细介绍了四步、五分钟Spring4快速集成Swagger的方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下

如果你所在的公司的还没有使用swagger甚至没有听说过swagger,赶快学习一下我的这篇博客吧,五分钟速成,傻瓜式的集成,但就是这么简单的应用一定会让他们震惊到的。

首先对swagger做一个简介吧:swagger是后台开发的神器,也是前后端交流的渠道。你可以用swagger做什么?首先,你以后基本可以告别单元测试了;其次,你不用再写接口文档了,也不需要写完之后再去对文档进行维护了。swagger可以完全模拟http请求,入参出参和实际情况差别几乎为零。说了这些,直接来干货吧!

集成四部曲:

第一步:导入两个依赖吧,如果你不是maven项目,那你去找找jar包吧,记住只需要两个,我看别的教程引入了七八个,简直是浪费。

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

第二步:添加一个类(拷贝下面的即可,注意修改包名,地址)

/**
 * Swagger配置
 *
 * @author wq
 * @since 2017-05-16
 */
@EnableWebMvc
@EnableSwagger2
@Configuration
public class SwaggerConfig {

  @Bean
  public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        .apis(RequestHandlerSelectors.basePackage("com.z*.b*.c*.controller")) 
        // 注意修改此处的包名
        .paths(PathSelectors.any())
        .build();
  }

  private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
        .title("接口列表 v1.1.0") // 任意,请稍微规范点
        .description("接口测试") // 任意,请稍微规范点
        .termsOfServiceUrl("http://url/swagger-ui.html") 
        // 将“url”换成自己的ip:port
       .contact("laowu") // 无所谓(这里是作者的别称)
        .version("1.1.0")
        .build();
  }
}

第三步:在mvc的配置的文件中添加下面配置,可能你的文件也许是叫 dispatcher.xml!(照抄即可,完全不需要修改)

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

第四步:在方法和参数上添加注解

方法上:
@ApiOperation(value = "教程", httpMethod = "POST", notes = "教程")
放在入参中:
@ApiParam(required = true, name = "test", value = "教程入参")

担心有些朋友还不太明白,放张图吧!

第五步:启动服务,然后在浏览器输入:

http://ip:port/swagger-ui.html

出现下面的画面就代表大功告成:

注意事项:如果你的项目中使用了拦截器,请将swagger资源放行(还是可以直接拷贝下面的配置,全部,不要怀疑v2)

<mvc:exclude-mapping path="/swagger*/**"></mvc:exclude-mapping>
<mvc:exclude-mapping path="/v2/**"></mvc:exclude-mapping>
<mvc:exclude-mapping path="/webjars/**"></mvc:exclude-mapping>

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

相关文章

  • Java中实现Comparable和Comparator对象比较

    Java中实现Comparable和Comparator对象比较

    这篇文章主要针对Java中Comparable和Comparator对象进行比较,感兴趣的小伙伴们可以参考一下
    2016-02-02
  • 浅谈Java随机数的原理、伪随机和优化

    浅谈Java随机数的原理、伪随机和优化

    这篇文章主要介绍了浅谈Java随机数的原理、伪随机和优化,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2019-01-01
  • java基于spring注解AOP的异常处理的方法

    java基于spring注解AOP的异常处理的方法

    本篇文章主要介绍了java基于spring注解AOP的异常处理的方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下。
    2017-02-02
  • Spring Cloud Hystrix 线程池队列配置(踩坑)

    Spring Cloud Hystrix 线程池队列配置(踩坑)

    这篇文章主要介绍了Spring Cloud Hystrix 线程池队列配置(踩坑),小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2019-01-01
  • Java中判断对象是否相等的equals()方法使用教程

    Java中判断对象是否相等的equals()方法使用教程

    与==运算符响应,equals()方法也是Java中对对象进行比较的一大方式,要特别注意二者的不同点,这个我们在下文中即将讲到,接下来我们就来看一下Java中判断对象是否相等的equals()方法使用教程
    2016-05-05
  • 浅谈为什么要使用mybatis的@param

    浅谈为什么要使用mybatis的@param

    这篇文章主要介绍了浅谈为什么要使用mybatis的@param,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-10-10
  • JAVAEE项目结构以及并发随想

    JAVAEE项目结构以及并发随想

    每个代码里面的工具都是工具,API是你最需要理解的,哪个好,哪个不好,没有准确答案。 一切皆对象,对于Java来讲是纯粹的,代理是对象,反射是对象,对象是对象,基本数据类型不是对象。
    2016-04-04
  • 详解使用Spring Cloud Consul实现服务的注册和发现

    详解使用Spring Cloud Consul实现服务的注册和发现

    这篇文章主要介绍了详解使用Spring Cloud Consul实现服务的注册和发现,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-06-06
  • java+selenium爬取图片签名的方法

    java+selenium爬取图片签名的方法

    这篇文章主要为大家详细介绍了java+selenium爬取图片签名的方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2019-08-08
  • 在Java SE上使用Headless模式的超级指南

    在Java SE上使用Headless模式的超级指南

    这篇文章主要介绍了在Java SE上使用Headless模式的超级指南,文中介绍了Headless模式实际使用的各种技巧,极力推荐!需要的朋友可以参考下
    2015-07-07

最新评论