脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → Spring4快速集成Swagger

四步五分钟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实现远程控制技术完整源代码分享

    Java实现远程控制技术完整源代码分享

    这篇文章主要为大家详细介绍了Java实现远程控制技术完整源代码，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2016-08-08
  • Java为什么使用补码进行计算的原因分析

    Java为什么使用补码进行计算的原因分析

    这篇文章主要介绍了Java为什么使用补码进行计算的原因分析，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
    2020-08-08
  • 利用栈使用简易计算器（Java实现）

    利用栈使用简易计算器（Java实现）

    这篇文章主要为大家详细介绍了Java利用栈实现简易计算器，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2019-09-09
  • java中的序列化解析

    java中的序列化解析

    这篇文章主要介绍了java中的序列化解析,为了将对象进行网络传输或者是持久化,我们需要将对象的状态信息转换为可以存储或者传输的形式,这个转换的过程就叫序列化,需要的朋友可以参考下
    2023-09-09
  • 分析Netty直接内存原理及应用

    分析Netty直接内存原理及应用

    Netty作为一个流行的应用框架，它的强悍之处是性能强悍，可以轻松承载数万并发; 其编程模型简单，容易上手; 这就给大家打开了一扇通向高性能的大门。高效io模型略去不说，我们今天主要来看看内存控制这块的强大之处
    2021-06-06
  • java中线程的状态学习笔记

    java中线程的状态学习笔记

    在本文里我们给大家整理了关于java中线程的状态的相关知识点内容，对此有需要的朋友们学习参考下。
    2019-03-03
  • Java实现联系人管理系统

    Java实现联系人管理系统

    这篇文章主要为大家详细介绍了Java实现联系人管理系统，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2022-02-02
  • Spring导入properties配置文件代码示例

    Spring导入properties配置文件代码示例

    这篇文章主要介绍了Spring导入properties配置文件代码示例,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-10-10
  • 解决在启动eclipse的tomcat进行访问时出现404问题的方法

    解决在启动eclipse的tomcat进行访问时出现404问题的方法

    这篇文章主要介绍了解决在启动eclipse的tomcat进行访问时出现404问题的方法，感兴趣的小伙伴们可以参考一下
    2016-04-04
  • MyBatis #{}和${} |与数据库连接池使用详解

    MyBatis #{}和${} |与数据库连接池使用详解

    本文将为大家说说关于 #{} 和 ${},这个是 MyBatis 在面试中最常问的面试题,以及数据库连接池相关的知识,感兴趣的朋友跟随小编一起看看吧
    2024-01-01

最新评论