swagger2隐藏在API文档显示某些参数
有时候，利用swagger2建立API文档时，有些参数是需要隐藏在API文档显示，在方法中，参数的名字前加上
@ApiIgnore 就可以了：
?
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
@PostMapping("modi/certificate")
@ApiResponses({@ApiResponse(code = 0, message = "请求成功"),
@ApiResponse(code = 10031, message = "商家的营业执照已经存在，不能重复入驻")
})
@ApiOperation(value = "修改商家证照资料", notes = "修改商家证照资料", response = MerchantExtendVdo.class)
@ApiImplicitParams({
@ApiImplicitParam(name = "merchantExtendVdo", value = "商铺对象", required = true, dataType = "MerchantExtendVdo"),
@ApiImplicitParam(name = "merchantProvepicVdo", value = "商铺证明图片", required = false, dataType = "MerchantProvepicVdo"),
@ApiImplicitParam(name = "merchantOtherVdoList", value = "商家的其他资质图片对象,List数组形式", required = false, dataType = "MerchantOtherVdo", allowMultiple = true, paramType = "body")})
public ResultData modiCertificate(@MultiRequestBody @ApiIgnore MerchantExtendVdo merchantExtendVdo,
@MultiRequestBody @ApiIgnore MerchantProvepicVdo merchantProvepicVdo,
@MultiRequestBody @ApiIgnore List<MerchantOtherVdo> merchantOtherVdoList) {
String accessToken = getAccessToken();
ResultData rd = storeService.modiCertificate(accessToken, merchantProvepicVdo, merchantOtherVdoList, merchantExtendVdo);
return rd;
}
|
swagger2自定义隐藏实体类属性
问题：
假如接收参数的实体类中关联了其他对象，那么swagger2的页面中参数应该会多出来这些，dept.id，dept.deptName，或者集合属性，roles[0].id，roles[0].roleName等等。
这些属性有可能是不需要用来接收参数的，出现在文档中会给前端开发人员带来困惑
笔者在swagger2提供的配置中没有找到隐藏此类参数的设置
解决
但是通过阅读源码找到了展开参数的类
springfox.documentation.spring.web.readers.parameter.ModelAttributeParameterExpander
笔者通过继承这个类，并添加
@Primary
注解覆盖了源码中的逻辑，修改了
getBeanPropertyNames
方法，其他不变