介绍
使用 swagger 只要按照规范去定义接口及接口相关信息,就可以生成接口文档,以及在线接口调试界面。
官网: https://swagger.io/
直接使用较为麻烦,可以使用 Knife4j 框架,是为 Java MVC框架集成 Swagger 生成 API 文档的增强解决方案。
使用方式
导入 Knife4f 的 maven 坐标
在配置类中加入 knife4f 的相关配置
设置静态资源映射,否则接口文档无法访问
常用注解
@Api
用在类上,表示对类的说明
@ApiModel
也是用在类上,例如 Entity,DTO,VO
@ApiModelProperty
用在属性上,描述属性信息
@ApiOperation
用在方法上,说明方法的用途、作用