Swagger是一个用于自动生成、更新、以及调试API接口的文档规范框架。当然，Springfox Swagger2框架就是基于Swagger规范实现的，用于在Spring生态系统中自动生成API接口文档的框架。最后，自动生成的接口文档大概是这样的：

在swagger中，常用注解如下：

一、修饰Controller

修饰整个类，用于描述这个controller的用途。主要用到以下两个参数：

修饰一个RESTFul接口的方法（controller里的方法），用于表示这是一个API接口。主要用到以下几个参数：

作用跟@ApiParam类似，用于描述请求的参数。不用之处在于， @ApiImplicitParam需要放在controller的方法上面，通常用于描述请求的参数。主要用到以下几个参数：

name：请求的参数名称
value：请求的参数的描述信息
dataTypeClass：请求的参数类型
paramType：参数的请求方式。这里的参数类型可以使用以下五种取值：path（以URL路径的形式提交数据）、query（以URL参数的形式提交数据）、body（以流的形式提交POST数据）、header（参数在请求的header里提交）、form（参数以form表单形式提交）

一个接口的请求中存在多个参数时可以使用这个注解，在一个@ApiImplicitParams注解中可以包含多个@ApiImplicitParam注解。

修饰一个RESTFul接口的方法，用于描述这个接口的返回信息。主要用到以下几个参数：

适用于方法参数位置，用于描述参数信息。主要用到以下两个参数：

修饰实体类，用于描述这个实体类是做什么的

修饰实体类的一个属性。主要用到以下几个参数：