Swagger

官网：https://swagger.io/

使用Swagger只需要按照规范去定义接口及接口相关的信息，再通过swagger衍生出来的一系列项目和工具，就可以做到生成各种格式的接口文档，以及在线接口调试页面等等。

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

<dependency>
    <groupId>com.xxx.yyy</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>3.0.2</version>
</dependency>

使用步骤：

1. 导入knife4j的maven坐标
2. 导入knife4j相关配置类
3. 设置静态资源，否则接口文档页面无法访问
4. 在LoginCheckFilter中设置不需要处理的请求路径 

常用注解：

注解	说明
@Api	用在请求的类上，例如Controller，表示对类的说明
@ApiModel	用在类上，通常是实体类，表示一个返回响应数据的信息
@ApiModelProperty	用在属性上，描述响应类的属性
@ApiOperation	用在请求的方法上，说明方法的用途、作用
@ApilmplicitParams	用在请求的方法上，表示一组参数说明
@ApilmplicitParam	用在@ApilmplicitParams注解中，指定一个请求参数的各个方面