如何整合SpringMVC和Swagger2,并且使用Mock数据进行联调

本文介绍了如何在SpringMVC项目中集成Swagger2,以实现快速生成接口文档,减少沟通成本。同时,文章还探讨了使用Mock数据进行接口联调的方法,帮助开发者提高效率。
摘要由CSDN通过智能技术生成

在开发中,我们经常会需要对接口进行联调沟通,然而这是在整个开发周期中最占用时间的一块。尤其最近在接手一个项目中,采用前后端分离开发的模式,写前端的同学完全不懂后台代码(对,我们之前都是一个人写前后端所有相关的代码滴!),接口经常性需要进行调整,基本就是重复沟通,重复浪费时间。于是我决定在项目中引进神器“Swagger”,用来一键生成文档,减少了后端开发同学编写接口文档的时间,同时前端采用Mock数据的方式,省略了等待接口的时间。下面详细介绍一下整合的过程。

  1. swagger介绍
    Swagger是遵守OpenAPI规范(OAS)的世界上最大的API框架开发工具,可在整个API生命周期内进行开发,从设计和文档到测试和部署。它提供了许多试用的工具来帮助开发者进行接口开发,如及时接口文档编写工具swagger-editor,前端展示swagger-ui等等。这里不再做详细的介绍。
    由于Swagger的版本更新较快,功能愈发强大,所以我选择了使用swagger2进行整合。
  2. 与springMVC集成
    因为我们是web项目,所以使用了springmvc。但是在实际运用场景中,swagger可以用在任何restful接口,稍微改造后也可以用在dubbo服务,RPC接口等。

    • 项目中引入swagger相关JAR包
      我们的项目是使用MAVEN做Jar包管理的,首先在pom.xml文件中加入以下配置:

       <!-- swagger 相关配置-->
              <dependency>
                  <groupId>io.springfox</groupId>
                  <artifactId>springfox-swagger2</artifactId>
                  <version>2.6.1</
  • 1
    点赞
  • 4
    收藏
    觉得还不错? 一键收藏
  • 1
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值