Swagger2集成SpringBoot,Swagger-ui页面怎么把Object的返回值类型（实际是泛型类）对应的属性展示到Example Value 区中？

最新推荐文章于 2023-09-01 16:24:40 发布
最新推荐文章于 2023-09-01 16:24:40 发布
阅读量1.7k 收藏
点赞数
文章标签： java swagger2 spring boot
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_44091895/article/details/113373161
版权

Swagger2不支持返回值为Object类型和Map，必须自定义转化类型，网上搜了好多都只有转化Map的，现在将Object类转化为对应泛型类,用上图红线代码，SwaggerUI页面Example Value区有返回值属性了，如下图，但是SingleDataResponse泛型类的data属性消失了，其父类的两个属性没消失，很奇怪，虽然把返回值全部改成SingDataResponse的泛型类可以解决，现在是想在Controller中不改变返回值（Object）的情况下在SwaggerUI页面中Example Value区展示对应返回值及属性，求各位大佬帮助解决下，搞了半天了一直没想到办法解决。

QQ：1209655494   有大佬帮我解决了 加QQ 我可以稍微感谢下!!!

苦尘
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
.Net5下使用OpenAPI(Swagger)生成webapi文档补充
Hello World
09-18 834
目录 一、前言 二、.net5下使用Swagger接口文档 二、 使用补充 1.接口返回结果日期时间类型格式化 2.设置接口返回结果中字段大小写原样返回 3.修改Swagger文档中Example Value示例参数的默认值 一、前言 上篇文章介绍了在.netcore2.1下使用Swagger文档的方法。 二、.net5下使用Swagger接口文档 项目升级到.net5以后配置基本没有变化，只是不再需要专门手动添加Swashbuckle.AspNetCore Nuget包的引用 .
swagger-example:用于测试的 swagger 示例应用程序
06-30
招摇的例子 带有球衣 1.18.2 spring 3.2.9 和球衣 1.3.12 swagger 的示例应用程序 主要目的是测试 swagger-ui 功能 示例端点 运行示例 mvn码头：运行 使用的示例来自： :
swagger2 2.9.2版本 swagger-ui页面不显示 请求实体 Example Value Model 坑
Wang8309166的博客
11-21 4535
在2.9.2中，当请求参数是带泛型的参数，例如List,PageCondition 再访问swagger页面的时候会出现没有显示Example Value Model ，也就是得自己手动取填写请求实体，即使注解写好了也依旧没有显示，还有注意即使把泛型括号换成 « 不是<< 也不是《 ， 而是法语中的 « ，也不好使，但是确实该这么写，所以最终决定换版本，改为3.0版本 <dependency> <groupId>io.springfox&
Swagger
weixin_30443747的博客
09-29 102
Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。 总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。 主要作用：1. 接口的文档在线自动生成。 2. 功能测试。 相关链接： Swagger使用指南：https://blog.csdn....
swagger2中多个实体model|examplevalue出现混淆/冲突BUG解决
阿瑟与非
07-17 9733
问题情景：使用两个类似的类作为接收参数或者返回参数时可能出现这种情况 原因：类上的注解使用的相同value值，此时就会出现冲突 @ApiModel(value = "菜品分类：DishCat1") swagger中看到的参数是冲突（此截图不冲突） ...
Swagger2接口文档中object返回类型没有显示在文档中
WeiLaiKeQiLx的博客
07-23 2361
Swagger2接口文档中object返回类没有显示 不知道大家有没有遇到一个问题就是原来的返回类Response中的data objcet类型 后来进行接口可视化引进Swagger的时候发现接口中只有入参有值而反参中的data数据没有显示 有人就纳闷了为啥呀 我data返回的是实体类啊 为啥没把类中的字段显示在swagger接口文档中啊 不要慌 是因为swagger它无法读取到你object的是什么类型 都知道object啥都可以存 这个时候有人又会说 我调用service接口返回的类型然后赋值到d
spring boot 2整合swagger-ui过程解析
08-25
在 `pom.xml` 文件中，你需要引入两个关键的 Springfox 库：`springfox-swagger2` 和 `springfox-swagger-ui`。这两个依赖分别提供了 Swagger 的核心功能和用户界面。例如： ```xml <groupId>io.springfox ...
111-springboot-demo-swagger-v2-bootstrap-ui.rar
03-07
从上述 Swagger 定义我们不难看出 Swagger 有以下 3 个重要的作用：将项目中所有的接口展现在页面上，这样后端程序员就不需要专门为前端使用者编写专门的接口文档；当接口更新之后，只需要修改代码中的 Swagger 描述...
SpringBoot＋Swagger-ui自动生成API文档
08-26
要在SpringBoot项目中集成Swagger-ui，首先需要在项目的pom.xml文件中添加两个关键依赖：springfox-swagger2和springfox-swagger-ui。这两个依赖分别用于核心的API文档生成和用户界面的展示。 ```xml <groupId>io...
koa2-swagger-ui：Swagger UI作为Koa v2中间件
02-03
koa2-swagger-ui 通过koa v2应用将swagger ui托管在给定目录中 灵感来源： 用于特定的路线 用于使用车把驱动的index.html从node_modules提供文件 安装 npm install koa2-swagger-ui --save 配置 有关更多...
SpringBoot-SwaggerUI:SpringBoot集成Swagger UI的example
05-30
SpringBoot-SwaggerUI是一个基于Spring Boot框架与Swagger UI集成的示例项目，它旨在帮助开发者轻松地构建具有API文档和交互式测试功能的应用程序。Swagger UI是一个强大的工具，允许开发人员通过用户友好的界面来...
【Swagger 】遇到 “Example values are not available for application/octet-stream media types.“
最新发布
木头大左的博客
09-01 353
如果您在使用 Swagger 时遇到 "Example values are not available for application/octet-stream media types." 错误，这通常是因为 Swagger 无法为 "application/octet-stream" 类型的响应提供示例值。"application/octet-stream" 是一种通用的二进制流媒体类型，它不包含任何特定的格式或结构信息。因此，Swagger 无法为这种类型提供示例值。
Swagger查看自定义泛型返回值
szw906689771的博客
03-22 2589
swagger使用通用返回值，并在返回值中定义了一个泛型用来接收返回前端的数据。swagger接口页面想要看到泛型中具体包含哪些字段时，需要在方法上标明数据类型，并且@ApiOperation注解上，不要使用response这个属性。 此处如果添加response这个属性，那么将看到的是此response属性对应的对象的包含字段。 转载：https://blog.csdn.net/Shiny__boy/article/details/109198747 ...
在swagger2如果传递的是对象 页面没有Example Value和Model信息的问题
qq_18973609的博客
12-02 1523
传递对象需要用@ApiImplicitParams包裹@ApiImplicitParam。 如： @ApiImplicitParams( { @ApiImplicitParam(name = "departmentParams", dataType = "DepartmentParams", value = "部门信息", required = true, paramType = "body") } ) 这样就会有model信息！！！
swagge中Example Value和model为空的情况解决
qq_42641261的博客
07-18 6874
问题描述：swagge中Example Value和model为空！！ 展示如下： 和其他接口比对发现 原来没有set和get方法 又因为使用lombok 所以加上注解@Data就可以了
SpringBoot设置swagger(基本使用)
lc1062657810的博客
07-12 403
1.准备工作 在SpringBoot项目中导入swagger2 swagger-ui依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </depe
Spring-Boot集成Swagger最全解
weixin_44015043的博客
08-22 731
文章目录Spring-Boot整合Swagger前言依赖注入基础配置APiInfoSwagger 配置扫描接口接口注解讲解@APi@ApiOperation@ApiImplicitParam@ApiModel@ApiModelProperty数据库代码部分所有的请求信息具体的请求信息GetMappingPostMapping返回类的具体封装ResponseCodeResultCode具体业务讲解（部分）模拟请求发送其他后记 Spring-Boot整合Swagger 源码地址：SpringBoot-Swag
Swagger文档的响应参数显示为“object”
世事洞明皆学问，人情练达即文章
11-12 2090
很奇怪的一个问题，封装的返回对象变成“object”了，后来发现是因为使用了JRebel插件启动了项目，目前没找到兼容的办法。
Swagger @Example 与 @ExampleProperty 使用无效原因
wang845252276的专栏
03-30 1165
Swagger UI不支持显示@Example描述
springboot集成swagger-ui
08-17
在Spring Boot项目中集成Swagger UI非常简单。以下是一些基本的步骤： 1. 添加Swagger依赖：在项目的`pom.xml`文件中添加Swagger的相关依赖。可以使用以下依赖： ```xml <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </dependency> ``` 2. 创建Swagger配置类：创建一个Java类，用于配置Swagger。可以使用以下示例代码： ```java import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.service.ApiInfo; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket apiDocket() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.basePackage("com.example.controller")) .paths(PathSelectors.any()) .build() .apiInfo(apiInfo()); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("API Documentation") .description("API Documentation for My Awesome App") .version("1.0.0") .build(); } } ``` 在上述代码中，`@EnableSwagger2`注解启用Swagger，`@Bean`注解创建一个`Docket`实例，配置Swagger的基本信息和扫描的包路径。 3. 启动应用程序：运行Spring Boot应用程序，Swagger UI将在`http://localhost:8080/swagger-ui.html`上自动启动。 现在，您可以在Swagger UI中浏览和测试您的API。Swagger UI将根据您的代码和注释生成API文档，并提供一个交互式的界面，供用户查看和测试API的各个端点和参数。 请注意，上述示例代码中的包路径和其他配置可能需要根据您的项目结构进行调整。此外，还可以通过其他配置选项来自定义Swagger UI的行为和外观。更多详细信息，请参阅Swagger和Springfox的官方文档。

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值