什么是Swagger
- swagger号称世界上最流行的API框架
- RestFul API文档自动生产工具,即API文档与API定义同步跟新
- 可以直接运行,直接在线测试API接口
- Swagger支持多门语言(例如:java,php,C#…)
为什么要使用Swagger
。。。。主要是为了必要前后端打起来
因为以前大家都是手写API文档的,在前后端分离的环境下,前端的页面需求进 行一次简单地修改需要后端进行更多的修改,例如前端需求多加了一个属性,后端就需要对数据库新增一个列字段,修改实体类,对先关代码全部进行修改,这需要花费大量精力。
偶尔一次还好,如果次数非常多而且前后端交流不到位的时候就会引发大问题,这时候Swagger提供了一个非常好的API测试接口,让开发人员直接测试,而且是实时跟新,无需要等待对方手写的API文档,减少了后端端口做好后前端对不上这种情况。
需要的依赖
使用方法一(官方)
- swagger2
- ui
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.7.0</version>
</dependency>
使用方法二(第三方工具)
<dependency>
<groupId>com.spring4all</groupId>
<artifactId>swagger-spring-boot-starter</artifactId>
<version>1.7.0.RELEASE</version>
</dependency>
使用方法在另一篇Swagger在SpringBoot的简单使用,这里只是对swqgger的简单理解和介绍