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

最新推荐文章于 2024-04-12 06:05:38 发布
最新推荐文章于 2024-04-12 06:05:38 发布
阅读量1.9k 收藏 3
点赞数 2
分类专栏： Swagger
原文链接：https://blog.csdn.net/qq_32917699/article/details/81486060
版权

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

今天做了一天@ApiModel希望Swagger生成的文档出现返回的内容注释，发现需要用到@ApiModel注解到你需要返回的类上

@ApiModelProperty作为字段的描述

例如 

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

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

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

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

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

github 链接：https://github.com/gyy528108/swagger.git

可以在Git 上自己下载

GavinYCF
关注
  • 2
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
关于Swagger@ApiModel返回内容注释不显示问题
qq_25635131的博客
10-23 3954
处理swagger返回值的时候返回VO不显示备注，乘了一波凉，先贴出别人栽的树：原文链接https://blog.csdn.net/qq_32917699/article/details/81486060 今天做了一天@ApiModel希望Swagger生成的文档出现返回的内容注释，发现需要用到@ApiModel注解到你需要返回的类上 @ApiModelProperty作为字段的描述 例如 之后文...
Swagger字段属性说明不显示
最新发布
qq_33240556的博客
05-23 985
解决此问题的一般步骤是先检查模型类上的注解是否完整且正确，然后检查Swagger的配置，最后考虑是否存在版本兼容性或前端显示问题。：有时候问题可能不在后端配置，而是前端Swagger UI的显示问题。：如果使用了特定的JSON序列化库（如Jackson或Gson），确保它们的配置没有无意间排除了Swagger需要的元数据。：确保在模型类（实体类）的字段或getter/setter方法上使用了Swagger提供的注解来提供描述信息。：检查Swagger配置是否正确开启了模型属性的展示。
关于Swagger的@ApiModel 返回内容注释不显示问题解决方案
玩转Java
04-27 7268
使用统一的返回封装类。
代码中加了@ApiModelProperty注解，swagger不显示注释？
wenxuankeji的博客
03-20 537
bugfix：代码中加了@ApiModelProperty注解，swagger不显示注释？
swagger @ApiModel 返回内容注释不显示问题
11-17
在使用Swagger进行API文档自动化生成时，可能会遇到`@ApiModel`注解的返回内容注释不显示的问题。这个问题通常是由于配置不当或者使用方法错误导致的。Swagger是流行的一款用于构建RESTful API的文档工具，它与...
springboot 整合swagger2.0支持API注释显示
12-02
然后，我们通过在控制器类和方法上添加Swagger2.0的注解来为API添加注释。例如，使用`@Api`注解标记控制器，`@ApiOperation`注解描述方法，`@ApiParam`注解参数等。 ```java @RestController @RequestMapping("/...
django-rest-swagger对API接口注释的方法
09-18
今天小编就为大家分享一篇django-rest-swagger对API接口注释的方法，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
swagger返回数据注解.zip
12-17
这个压缩包文件“swagger返回数据注解.zip”很可能包含了如何使用 Swagger 注解来定义和展示 API 返回的数据的相关资料。 Swagger 注解主要用在 Java 类和方法上，以便在 Swagger 文档中生成相应的描述。以下是一些...
swagger-jsdoc：基于jsDoc注释和YAML文件生成swaggeropenapi规范
02-16
入门swagger-jsdoc将经过验证的OpenAPI规范返回为JSON或YAML。 const swaggerJsdoc = require ( 'swagger-jsdoc' ) ;const options = { swaggerDefinition : { openapi : '3.0.0' , info : { title : 'Hello World' ...
swagger查询结果中注释不显示问题
JUST DO IT，就是干IT！
12-01 3778
基本的注解不多说了，大家都会，注意点就是controller层的返回结果，如果包装了泛型，需要明确指出，如下图红框 注：如果红框中直接写为Object 返回值什么都正常，但是字段注解不会显示
swagger文档添加@ApiModelProperty注解后请求参数不显示注释
m0_64776123的博客
03-04 362
swagger文档添加@ApiModelProperty注解后请求参数不显示注释
Swagger中配置了@ApiModelProperty的allowableValues属性但不显示的问题
2401_84002730的博客
04-12 794
面试的时候我们对知识的掌握有时候很难面面俱到，把自己的思路说出来，而不是直接告诉面试官自己不懂，这也是可以加分的。趣的新人，都欢迎扫码加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！，范围包含最全MySQL、Spring、Redis、JVM等最全面试题和答案，仅用于参考。(img-TVAI9UE3-1712873123007)]以上就是蚂蚁技术四面和HR面试题目，
swagger注解（@ApiModelProperty）实体类swagger-ui不显示问题
zhangwenchao0814的博客
05-13 7478
实体类首字母必须小写，否则swagger-ui界面显示对象的参数说明不显示、是否必输属性即使指定必输也是显示false；比如数据库中字段为B_WORKDAYFLAG，使用mybatis-plus代码生成器工具生成后是bWorkDayFlag，此时可以在mybatis-plus代码生成器中设置生成实体类时去掉字段前缀，如： strategy.setFieldPrefix("B_", "C_", "D_", "VC_"); //生成实体时去掉字段前缀 *** 代码*** public static void
SwaggerBootstrapUi注释不显示
qq_44094980的博客
01-27 1860
SwaggerBootstrapUi使用大坑-不显示注释 今天写一个接口的时候发现一个奇葩的问题，就是swagger不显示注释的问题，网上百度了很多也没有解决，发现一个SwaggerBootstrapUi的小bug. 先看下我的返回数据封装，有做强泛型指定： controller层 @GetMapping("info/{skuId}") @ApiOperation(value = "获取商品详情", notes = "获取商品详情") @EncryptResponse public
解决Swagger 添加了@ApiModel注解 在文档中不显示对象问题
m0_55584658的博客
08-17 2216
解决Swagger 添加了@ApiModel注解在文档中不显示对象问题
swagger中@API，@ApiModel @ApiModelProperty
09-21
@ApiOperation和@ApiModel是Swagger框架中的注解，用于生成API文档。@ApiOperation用于描述一个接口的操作，@ApiModel用于描述一个实体类。@ApiModelProperty用于描述实体类中的字段。 在上面的例子中，@ApiModel("查询机构入参")用于描述OrgDTO这个实体类，表示该实体类是用于查询机构的入参。@ApiModelProperty(value = "机构号")和@ApiModelProperty(value = "名字")分别用于描述OrgDTO中的orgCode和name字段，其中value属性用于指定字段的描述信息。

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值