介绍:

使用Swagger你只需要按照它的规范去定义接口及接口相关的信息，就可以做到生成接口文档，以及在线接口调试页面.简单来说就是我们只需要知道使用Swagger可以帮助我们后端生成接口文档

Swagger官网:https://swagger.io/

因为单独使用Swagger会有些繁琐,所以用到了Knife4j框架

Knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案。

---

使用方式:
1.导入 knife4j的maven坐标(相关的依赖)

2.在配置类中加入 knife4j相关配置

3.设置静态资源映射，否则接口文档页面无法访问

---

常用注解:

这几个注解可以说是可以直接影响到我们最终生成的接口文档,因为不少的参数+参数名称都是靠这几个注解传过来的,并且它可以让接口文档有更好的可读性

@Api:

@ApiModel:

@ApiModelProperty:

@ApiOperation: