场景问题
在返回结果如果为泛型封装的话,Response,swagger不展示T的文档说明。
可能的问题如下:
- swagger版本太低,建议使用3.0.0+
- 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 返回值 字段属性说明不显示 不显示泛型