SpringFox介绍
SpringFox是一个开源的API Doc的框架, 它的前身是swagger-springmvc,可以将我们的Controller中的方法以文档的形式展现。官方定义为:Automated JSON API documentation for API's built with Spring。
Swagger介绍
Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。
SpringFox使用教程
第一步:Maven框架机构Springboot项目,依赖SpringFox包:
<
第二步:在Springboot项目启动添加注解@EnableOpenApi:
第三步:创建测试API接口,包含实体类/控制器用户实体类:
package
用户控制器:
package
API统一响应工具类:
package
第四步:启动Springboot项目,访问Swagger页面:http://localhost:8080/swagger-ui/index.html
打开其中一个API接口文档,可以包含接口的请求与响应的详细信息,并且支持在线接口测试。
注解说明
本文测试案例总共用到4个SpringFox注解,如下:
@Api:用在类上,说明该类的作用。可以标记一个Controller类做为swagger 文档资源。@ApiOperation:用在方法上,说明方法的作用,每一个url资源的定义。@ApiModel:描述一个Model的信息。@ApiModelProperty:描述一个model的属性。
以上就是Springboot集成SpringFox生成Swagger接口文档的详细教程,虽然Swagger存在代码入侵性,但是在Api接口测试方面,它还是非常的不错,目前还多大公司使用改插件,可见其便捷性了。