如何快速搞定在线接口文档
之前我们的测试都是基于前端页面进行测试的,但是在企业中我们前端和后端开发都是并行开发的,有可能我们要测试的时候,前端页面还没有写好。现在如果我们与前端对接,需要提供详细的接口文档才行,不过在开发的过程中,接口文档可能不能及时的提供,或者是更新不及时,就会造成信息闭塞,造成不必要的效率降低。
所以,一般的前后端分离的项目,都会采用在线的接口工具进行调试,可以实时的展示接口的详细数据
Swagger介绍
Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务
官网:https://swagger.io/autolink。
它的主要作用是:
- 使得前后端分离开发更加方便,有利于团队协作
- 接口的文档在线自动生成,降低后端开发人员编写接口文档的负担
- 功能测试
Spring已经将Swagger纳入自身的标准,建立了Spring-swagger项目,现在叫Springfox。通过在项目中引入Springfox ,即可非常简单快捷的使用Swagger。
knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,取名knife4j是希望它能像一把匕首一样小巧,轻量,并且功能强悍!
目前,一般都使用knife4j框架。
导入依赖
导入 knife4j 的maven坐标(注意:由于knife4j是基于swagger的,所以也会自动导入swagger的依赖)
注意:已经在zzyl-common工程中导入完成了
<dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-boot-starter</artifactId> </dependency>