一、 介绍
swagger 采用的是2.7版本
maven 工程引入
本方介绍 swagger 顺序为 接口参数 -> 接口返回数据
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.7.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.7.0</version> </dependency>
二、注解使用
- Controller 类上注释，使用@Api为指定Controller 生成注释 tag
@Api(tags = "描述")效果图如下
1.png
- 在Controller 中的方法上使用注解 @ApiOperation("")
@ApiOperation("方法描述")，效果图如下
method.png
- 接口参数描述，使用 @ApiParam("") 注解在方法声明上的参数，或者对象的成员变量。
@ApiParam("分页参数")用对象接收参数需要在类上加上 @ApiModel("") 注解
@ApiModel("分页查询对象")
public class PageQueryDTO {
@ApiParam("第几页开始")
private String pageIndex = "1";
}
效果图
params.png
- 接口返回数据字段解释，在返回的对象类上使用 @ApiModel，在类的成员变量上使用 @ApiModelProperty()
@ApiModel
public class ReportVisitLogVO {
@ApiModelProperty("x 坐标")
private List<String> positionXList;
@ApiModelProperty("y 坐标")
private List<String> positionYList;
}
效果图
responseData.png
