在开发中,我们经常会需要对接口进行联调沟通,然而这是在整个开发周期中最占用时间的一块。尤其最近在接手一个项目中,采用前后端分离开发的模式,写前端的同学完全不懂后台代码(对,我们之前都是一个人写前后端所有相关的代码滴!),接口经常性需要进行调整,基本就是重复沟通,重复浪费时间。于是我决定在项目中引进神器“Swagger”,用来一键生成文档,减少了后端开发同学编写接口文档的时间,同时前端采用Mock数据的方式,省略了等待接口的时间。下面详细介绍一下整合的过程。
- swagger介绍
Swagger是遵守OpenAPI规范(OAS)的世界上最大的API框架开发工具,可在整个API生命周期内进行开发,从设计和文档到测试和部署。它提供了许多试用的工具来帮助开发者进行接口开发,如及时接口文档编写工具swagger-editor,前端展示swagger-ui等等。这里不再做详细的介绍。
由于Swagger的版本更新较快,功能愈发强大,所以我选择了使用swagger2进行整合。 与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</