一、引入pom依赖
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
</dependency>
二、开启swagger
三、编写注解,对Swagger UI中的接口进行解释说明
说明:
@Api注解
@Api 注解
属性介绍:
tags 设置标签
description 设置描述信
@Api(tags = "评论",description = "评论相关接口")
@ApiOperation
@ApiOperation(value = "友链评论列表",notes = "获取一页友链评论")
@ApiOperation(value = "友链评论列表",notes = "获取一页友链评论")
@ApiImplicitParam
@ApiImplicitParam 用于描述接口的参数,但是一个接口可能有多个参数,所以一般与 @ApiImplicitParams 组合使用。
@ApiImplicitParams({
@ApiImplicitParam(name = "pageNum",value = "页号"),
@ApiImplicitParam(name = "pageSize",value = "每页大小")
}
@ApiModel用于描述实体类。
@ApiModel(description = "添加评论dto")
@ApiModelProperty用于描述实体的属性
@ApiModelProperty(notes = "评论类型(0代表文章评论,1代表友链评论)")
private String type;
//文章id
@ApiModelProperty(notes = "文章id")
private Long articleId;
@ApiModel和@ApiModelProperty演示示例