点击上方 Java后端,选择 设为星标
优质文章,及时送达![3253b9740d947cae628814e80e28f738.png](https://i-blog.csdnimg.cn/blog_migrate/1fd3b401e2ee7938f4900cb608b5df8c.jpeg)
目录
一:swagger是什么?
二:为什么要使用swaager?
三:如何搭一个swagger?
四:如何在项目中集成swagger
五:使用swagger需要注意的问题
六:总结
一:swagger是什么?
Swagger是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化RESTful风格的Web服务。目标是使客户端和文件系统作为服务器以同样的速度来更新文件的方法,参数和模型紧密集成到服务器。这个解释简单点来讲就是说,swagger是一款可以根据resutful风格生成的生成的接口开发文档,并且支持做测试的一款中间软件。
二:为什么要使用swaager?
2.1:对于后端开发人员来说
①:不用再手写WiKi接口拼大量的参数,避免手写错误
②:用起来很简单,采用全注解的方式,开发简单
③:方法参数名修改、增加、减少参数都可以直接生效,不用手动维护
④:缺点:增加了开发成本,写接口还得再写一套参数配置
2.2:对于前端开发来说
①:后端只需要定义好接口,会自动生成文档,接口功能、参数一目了然
②:联调方便,如果出问题,直接测试接口,实时检查参数和返回值,就可以快速定位是前端还是后端的问题
2.3:对于测试
①对于某些没有前端界面UI的功能,可以用它来测试接口
②操作简单,不用了解具体代码就可以操作
三:如何搭一个swagger
3.1:引入swagger的依赖,目前推荐使用2.7.0版本,因为2.6.0版本有bug,而其他版本又没有经过验证,所以在比较保守的情况下,我比较推荐的版本是2.7.0,并且它是经过我验证的。
欢迎关注微信公众号:Java后端
一:引入Swagger依赖库
<dependency>
<groupId>io.springfoxgroupId>
<artifactId>springfox-swagger2artifactId>
<version>2.7.0version>
dependency>
<dependency>
<groupId>io.springfoxgroupId>
<artifactId>springfox-swagger-uiartifactId>
<version>2.7.0version>
dependency>
3.2:springBoot整合swagger
springboot整合swagger,只需要添