Swagger 忽略某些参数,使其不出现在接口文档中

控制器中的某个方法:

@GetMapping(value = "page")
@ApiOperation(value = "分页查询登录日志")
@ApiImplicitParams({
     @ApiImplicitParam(name = "page", value = "分页参数:当前页", defaultValue = "1", required = false),
     @ApiImplicitParam(name = "limit", value = "分页参数:每页数量", defaultValue = "10", required = false),
     @ApiImplicitParam(name = "loginname", value = "登录名称", required = false),
     @ApiImplicitParam(name = "loginip", value = "IP", required = false),
     @ApiImplicitParam(name = "startTime", value = "登录起始时间", required = false),
     @ApiImplicitParam(name = "endTime", value = "登录终止时间", required = false)
})
public Result page(LogVo vo) {
  	return null;
}

没有使用 @ApiIgnore 注解之前,在接口文档中存在一些不期望出现的请求参数:
在这里插入图片描述

为了隐藏这些不期望出现的请求参数,可以在方法的参数上使用 @ApiIgnore 注解,见以下代码块中的第 11 行:

@GetMapping(value = "page")
@ApiOperation(value = "分页查询登录日志")
@ApiImplicitParams({
     @ApiImplicitParam(name = "page", value = "分页参数:当前页", defaultValue = "1", required = false),
     @ApiImplicitParam(name = "limit", value = "分页参数:每页数量", defaultValue = "10", required = false),
     @ApiImplicitParam(name = "loginname", value = "登录名称", required = false),
     @ApiImplicitParam(name = "loginip", value = "IP", required = false),
     @ApiImplicitParam(name = "startTime", value = "登录起始时间", required = false),
     @ApiImplicitParam(name = "endTime", value = "登录终止时间", required = false)
})
public Result page(@ApiIgnore LogVo vo) {
    return null;
}

这样就可以忽略某些不期望出现的请求参数:
在这里插入图片描述

注意:如果使用 @ApiIgnore 注解,但却没有使用 @ApiImplicitParam 注解隐式地声明接口参数,如下:

@GetMapping(value = "page")
@ApiOperation(value = "分页查询登录日志")
public Result page(@ApiIgnore LogVo vo) {
    return null;
}

那么在接口文档中,是不会出现任何参数的:
在这里插入图片描述

  • 11
    点赞
  • 29
    收藏
    觉得还不错? 一键收藏
  • 7
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 7
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值