api在线文档swagger常用的注解

背景：最近做前后端分离开发，我负责后端接口提供，自然少不了api接口文档。选择了比较容易上手的swagger。

1.@Api(tags = "案例管理")

 解释：这个注解用在Controller类上面,tags是接口模块的名称。

代码截图：

效果截图：

2、@ApiOperation(value = "查询案例管理列表",notes = "页码为必要参数，时间格式: 年-月-日")

 解释：这个注解是接口方法上使用的，value是这个接口方法的功能描述，notes属性是强调的注意事项。

代码截图：

效果截图：

 

 

 

3、

@ApiImplicitParams({
        @ApiImplicitParam(name = "pageNum", value = "当前页",paramType="query",dataType = "int",required = true),
        @ApiImplicitParam(name = "pageSize", value = "每页条数",paramType="query",dataType = "int",required = true),
        @ApiImplicitParam(name = "caseName", value = "案例名称",paramType="query"),
        @ApiImplicitParam(name = "modelId", value = "模型id",paramType="query"),
        @ApiImplicitParam(name = "params[beginTime]", value = "开始时间",paramType="query"),
        @ApiImplicitParam(name = "params[endTime]", value = "结束时间",paramType="query")
})

解释：@ApiImplicitParams和@ApiImplicitParam一般是同时存在的，@ApiImplicitParams是参数组，@ApiImplicitParam是具体某个参数的设置。经常为get请求设置参数时使用。

代码截图：

效果截图：

 

 4、public TableDataInfo list(@ApiIgnore TbCase tbCase)

解释：@ApiIgnore忽略某个参数，一般用于方法参数列表中，表示让swagger忽略掉这个参数。经常为get请求忽略方法中的对象参数使用。并让@ApiImplicitParams中的参数生效。

代码截图：

效果截图：

 

 5、@EnableOpenApi 

解释：放在启动类上，表示开启swagger功能

代码截图：

6、@ApiModel(value = "UserEntity", description = "用户实体")

 解释：这个是对实体类进行说明的注解，我不咋用

代码截图：