Swagger2接口文档中object返回类型没有显示在文档中

最新推荐文章于 2024-02-23 14:15:00 发布
最新推荐文章于 2024-02-23 14:15:00 发布
阅读量2.2k 收藏 1
点赞数 1
文章标签： java swagger2
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/WeiLaiKeQiLx/article/details/119038602
版权

Swagger2接口文档中object返回类没有显示
不知道大家有没有遇到一个问题就是原来的返回类Response中的data objcet类型 后来进行接口可视化引进Swagger的时候发现接口中只有入参有值而反参中的data数据没有显示 有人就纳闷了为啥呀 我data返回的是实体类啊 为啥没把类中的字段显示在swagger接口文档中啊 不要慌 是因为swagger它无法读取到你object的是什么类型 都知道object啥都可以存 这个时候有人又会说 我调用service接口返回的类型然后赋值到data中 难道swagger没有查到 啊 问的好 我也不知道 哈哈 但是我知道他不会显示在swagger文档中，不要慌有解决方法 给Response返回类加上泛型 把data属性类型换成泛型
在这里插入图片描述
在接口返回的上加上你要返回的类型
在这里插入图片描述
结果
在这里插入图片描述

WeiLaiKeQiLx
关注
  • 1
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
swagger @ApiModel 返回内容注释不显示问题
11-17
swagger @ApiModel 返回内容注释不显示问题 展开无类信息
Swagger API文档Responses中Object类型无法显示，求指引
weixin_45896131的博客
02-28 1938
问题： Result类 package com.dreamfuture.elearning.util; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import javax.servlet.http.HttpServletResponse; import ja
swagger通用响应结果字段显示不全或返回数据类型不显示
最新发布
w先生的博客
02-23 435
注解中相应参数或者删除实体类上该注解即可。去除通用响应实体类上。
Swagger2返回值Map,Json，实体类部分字段注释描述信息说明
击水三千里的专栏
09-01 1万+
问题描述 swagger2没有提供描述返回值的api，导致不能注解map类型的返回值，不能返回json，也不能描述只返回一个实体类中的部分字段的情况。我们需要自己实现这个功能。 网上找到的思路 实际上我在网上发现有人实现了这个功能，实现的原理是使用第三方jar包生成一个类，这个类里包括返回值里应该有的字段，这些字段使用原生的swagger注解，再让swagger去解析这个类。 这样做的优点是确实把参数信息加入了swagger的缓存中；缺点是需要生成额外的类。 这个思路的链接在这里 我自己的思路
Swagger使用介绍三之为Controller中参数添加JSONObject类型字段说明
shangcunshanfu的博客
09-17 8552
回顾 上文中我们介绍了如果给Controller中的参数添加字段说明：https://blog.csdn.net/shangcunshanfu/article/details/100838687，也留下了一个问题，那就是如何给JSONObject类型的参数添加字段说明，本章就来进行介绍 说明 Swagger其实是没有针对JSONObject添加字段说明功能的，这也很好理解，因为Swagger并没...
swagger统一返回对象没有展示名称
你就像甜甜的益达
06-11 4976
我们使用的统一返回对象 然后swagger里面展示的一直是这样: 没有将data里面数据展示出来,后来细看,发现没有加泛型,加上泛型: 解决: 我们只需要将返回实体类上面加上对应注解即可: @ApiModelProperty(value = "主键", example = "1") ...
解决接口返回泛型的时候 swagger2 ui页面不显示文档的问题
迪巴哥的博客
03-01 1742
项目场景： 提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档 文章目录项目场景：前言一、pandas是什么？二、使用步骤1.引入库2.读入数据总结问题描述：原因分析：解决方案： 前言 提示：这里可以添加本文要记录的大概内容： 例如：随着人工智能的不断发展，机器学习这门技术也越来越重要，很多人都开启了学习机器学习，本文就介绍了机器学习的基础内容。 提示：以下是本篇文章正文内容，下面案例可供参考 一、pandas是什么？ 示例：pandas 是基于NumPy 的一种工具，该工具是为了解决数
springboot控制接口返回的字段_springBoot 整合 swagger 展示返回对象的嵌套属性文档注释...
weixin_39876650的博客
01-16 736
spring boot 处理 swagger 嵌套数据展示在开发的过程中,我们会常常使用swagger做我们的在线文档.我们会在对象的属性上使用@ApiModelProperty 等api注解,但是遇到对象嵌套的时候,如何返回一个嵌套的json文档就需要我们做一些简单的处理如果只在对象某个属性上使用 @ApiModelProperty 并不会起作用1234567891011121314151617...
解决Swagger 添加了@ApiModel注解 在文档中不显示对象问题
m0_55584658的博客
08-17 2143
解决Swagger 添加了@ApiModel注解在文档中不显示对象问题
Swagger2集成SpringBoot,Swagger-ui页面怎么把Object的返回值类型（实际是泛型类）对应的属性展示到Example Value 区中？
qq_44091895的博客
01-29 1756
Swagger2不支持返回值为Object类型和Map，必须自定义转化类型，网上搜了好多都只有转化Map的，现在将Object类转化为对应泛型类,用上图红线代码，SwaggerUI页面Example Value区有返回值属性了，如下图，但是SingleDataResponse泛型类的data属性消失了，其父类的两个属性没消失，很奇怪，虽然把返回值全部改成SingDataResponse的泛型类可以解决，现在是想在Controller中不改变返回值（Object）的情况下在SwaggerUI页...
springfox-swagger2-2.2.2-API文档-中文版.zip
06-26
赠送原API文档：springfox-swagger2-2.2.2-javadoc.jar； 赠送源代码：springfox-swagger2-2.2.2-sources.jar； 赠送Maven依赖信息文件：springfox-swagger2-2.2.2.pom； 包含翻译后的API文档：springfox-swagger2-...
SpringBoot集成Swagger2生成接口文档的方法示例
08-26
我们提供Restful接口的时候，API文档是尤为的重要，它承载着对接口的定义，描述等，本文主要介绍了SpringBoot集成Swagger2生成接口文档的方法示例，需要的朋友们下面随着小编来一起学习学习吧
Java利用Swagger2自动生成对外接口的文档
08-27
主要介绍了Java利用Swagger2自动生成对外接口的文档，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
提高生产率swagger接口文档映射生成前端接口方法
01-08
前后端分离时，前端对接口都需要有接口文档，根据...我们可以根据swagger接口文档，前端来自动生成接口方法 根据swagger.json文件来npm 生成接口方法 接口信息都截去了 原创文章 60获赞 17访问量 21万+ 关注 私信
springfox-swagger2-2.9.2-API文档-中文版.zip
07-13
赠送原API文档：springfox-swagger2-2.9.2-javadoc.jar； 赠送源代码：springfox-swagger2-2.9.2-sources.jar； 赠送Maven依赖信息文件：springfox-swagger2-2.9.2.pom； 包含翻译后的API文档：springfox-swagger2-...
swagger实体类生成不了文档的解决办法
连边
07-09 1188
swagger版本 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.8.0</version> </dependency> <dependency> <groupId>com.github.xiaoy
如何Swagger2接口文档返回json、map等对象的备注说明
热门推荐
汤菜的博客
02-22 3万+
一、遇到问题 目前使用Swagger2形成接口文档时，当系统设计的接口返回的类型不是实体对象时，Swagger2无法在接口文档页面中显示返回结果字段说明，比如返回json、map等可以存储key-val形式的类型；均无法在接口文档页面上显示返回的字段备注说明，所以怎么才能像实体对象一样显示正常的model字段说明是我们这次需要解决的问题； 二、实现思路 1、首先告诉Swagger2该接口需要...
Swagger查看自定义泛型返回值
szw906689771的博客
03-22 2564
swagger使用通用返回值，并在返回值中定义了一个泛型用来接收返回前端的数据。swagger接口页面想要看到泛型中具体包含哪些字段时，需要在方法上标明数据类型，并且@ApiOperation注解上，不要使用response这个属性。 此处如果添加response这个属性，那么将看到的是此response属性对应的对象的包含字段。 转载：https://blog.csdn.net/Shiny__boy/article/details/109198747 ...
Swagger文档的响应参数显示为“object”
世事洞明皆学问，人情练达即文章
11-12 2021
很奇怪的一个问题，封装的返回对象变成“object”了，后来发现是因为使用了JRebel插件启动了项目，目前没找到兼容的办法。
在 Micronaut 框架中使用 Swagger 生成接口文档
07-14
在 Micronaut 框架中使用 Swagger 生成接口文档，你可以按照以下步骤进行操作： 1. 首先，确保在你的项目中添加了 Micronaut Swagger 插件的依赖。在项目的构建文件（如 `build.gradle` 或 `pom.xml`）中添加以下依赖： ```groovy implementation("io.micronaut.configuration:micronaut-swagger-ui") implementation("io.swagger.core.v3:swagger-annotations") ``` 2. 在 Micronaut 应用程序的配置文件（如 `application.yml` 或 `application.properties`）中，添加以下配置信息： ```yaml micronaut: endpoints: swagger: enabled: true ``` 3. 在你的控制器类或方法上，使用 Swagger 注解来定义接口文档。例如： ```java import io.micronaut.http.MediaType; import io.micronaut.http.annotation.Controller; import io.micronaut.http.annotation.Get; import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.tags.Tag; @Controller("/api") @Tag(name = "Example") public class ExampleController { @Get(uri = "/example", produces = MediaType.TEXT_PLAIN) @Operation(summary = "Get example data") public String getExampleData() { return "Example data"; } } ``` 4. 启动你的 Micronaut 应用程序，并访问 `/swagger` 路径来查看生成的 Swagger UI。例如：`http://localhost:8080/swagger` 通过以上步骤，你就可以在 Micronaut 应用程序中使用 Swagger 生成接口文档了。记得根据你的实际需求，添加更多的 Swagger 注解来完善接口文档。

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值