关于Swagger @ApiModel 返回内容注释不显示问题

Posted 奔跑吧人生

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了关于Swagger @ApiModel 返回内容注释不显示问题相关的知识,希望对你有一定的参考价值。

@ApiModel希望Swagger生成的文档出现返回的内容注释,发现需要用到@ApiModel注解到你需要返回的类上

@ApiModelProperty作为字段的描述
例如

 

 

 

之后文档还是不显示返回内容的注释,

原来是因为封装的返回类没做泛型 需要加入泛型

 

 

 

封装的返回类加入泛型之后,还需要在你Controller返回的数据也加上泛型,不然还是展示不出来的

 

 

 

这样,返回的数据就带上注释了

 

 

 

完美解决了返回内容不带注释的问题

以上是关于关于Swagger @ApiModel 返回内容注释不显示问题的主要内容,如果未能解决你的问题,请参考以下文章

自定义SpringBoot+Swagger中@ApiModel默认名称

swagger 常用注解

@ApiModel和@ApiModelProperty用法

swagger2 注解说明

在实体类中添加了@ApiModel不起作用

swagger-ui及swagger用法