swagger 泛型T无法显示

场景问题

在返回结果如果为泛型封装的话,Response,swagger不展示T的文档说明。
可能的问题如下:

  1. swagger版本太低,建议使用3.0.0+
  2. Response 基础类被声明了@ApiModel或者schema,或者T data的getData方法不是T,而是Object,同时返回的方法使用了Response,而不是Response

Response类定义建议如下:

public class Rest<T> {

    @ApiModelProperty(value = "是否成功")
    private boolean success=true;
    @ApiModelProperty(value = "返回对象")
    private T data;
    @ApiModelProperty(value = "错误编号")
    private Integer errCode;
    @ApiModelProperty(value = "错误信息")
    private String message;
	// setter/getter ..
}

注意如下问题:

1、基础封装泛型类中,不能使用@ApiModel注解来约束该泛型类的类名称,因为泛型类一旦用该注解进行约束后,在OpenAPI的结构中,类名称就只有一个,会导致字段属性找不到的情况。错误的代码示例:

/*
* 泛型类中不能使用@ApiModel注解,应该去掉
*/
@ApiModel("结果类")
public class Rest<T> {
    //....
}

2、针对泛型T的属性,不应该在使用@ApiModelProperty注解时,赋予example值,错误的代码示例:

public class Rest<T> {
    /*
    * 泛型T属性不能赋予example值,因为T有可能是实体类,这样赋值会导致生成的示例值不一致,应该交给框架去解析类结构
    */
    @ApiModelProperty(value = "返回对象",example="Test")
    private T data; 
}

参考文章:
knife4j swagger2 返回值 字段属性说明不显示 不显示泛型

  • 10
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值