swagger返回多数据列表,中文注释

最新推荐文章于 2023-06-28 15:56:56 发布
最新推荐文章于 2023-06-28 15:56:56 发布
阅读量6.3k 收藏 4
点赞数 3
分类专栏： swagger 文章标签： java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/shaokunkun/article/details/105728239
版权

因为业务需要,一个查询接口,需要给前端返回二个列表对象数据,用map返回,发现swagger没有各个字段的中文注释,最简单方式还是封装一个组合实体类,将需要返回前端的数据都封装在里面即可!最后将该实体类再controller层定义好实际返回泛型即可!

自定义的组合类,记得定义泛型哦!不然中文注释无法显示

控制层这里要定义好返回值泛型

最后swagger的返回参数字段中文注释就完美显示出来了哦!

坤菲我要飞
关注
  • 3
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
正则提取Swagger在线文档里面的返回实体类字段
北辰
06-18 827
说明：由于此问题也是关于数据正则提取的，但其实和Python没有什么关联，为了方便整理特此放在了该目录下面
fastapi给swagger在线接口文档添加参数注释与示例
最新发布
ithongchou的博客
08-08 403
在使用 FastAPI 或者其他支持 Pydantic 的框架时，这些示例值会被用来生成 API 文档，并在文档中展示请求体的示例数据，从而帮助用户了解请求体的结构和字段的预期格式。参数用于为请求体（Body）的数据添加示例，这对于生成 API 文档时展示请求体数据的结构和格式非常有用。），这些描述信息也会在生成的 API 文档中显示出来，帮助用户理解请求体的结构和用途。路由的详细说明，包括请求体的结构和示例数据，这些示例数据就是通过。信息来生成 API 文档，并在文档中展示请求体的示例数据。
swagger2 注解说明
人，一定要有激情
08-26 920
目录 1、@Api 2、@ApiOperation 3、@ApiOperation 3、@ApiImplicitParams、@ApiImplicitParam 4、@ApiResponses、@ApiResponse 5、@ApiModel、@ApiModelProperty 6、 @PathVariable 7、 @RequestParam Swagger是一个开放源代码软件框架，由大型工具生态系统支持，可帮助开发人员设计，构建，记录和使用RESTful Web服.
Swagger显示中文注释
qq_60147611的博客
06-28 600
services.AddSwaggerGen(options => { var basectory = System.AppDomain.CurrentDomain.BaseDirectory; var ctory = System.AppDomain.CurrentDomain.FriendlyName + ".xml"; var text = Path.Co
【IDEA】【Swagger】接口返回 List＜Class＞ 类型时 404
WWGtest的博客
12-02 1411
记录一下接口返回List类型时404的问题 解决方案:相应接口添加 @ResponseBody注解
swagger返回数据说明字段注释说明（已解决）
sgycoder的博客
11-18 2万+
本人开发时跟前端对接，swagger没有右侧的注释被吐槽了，查了半天发现是没有给返回值ResponseEntity定义泛型 没有泛型就没有注释说明 不过前提是实体类配置 @ApiModelProperty() 如果能帮到你，就给点个赞吧。谢谢！！ ...
把swagger都整懵逼的返回对象
weixin_38390086的博客
12-31 1269
java.lang.reflect.Type 及其子类的应用与学习 ParameterizedType，GenericArrayType，WildcardType，WildcardType
swagger @ApiModel 返回内容注释不显示问题
11-17
在使用Swagger进行API文档自动化生成时，可能会遇到`@ApiModel`注解的返回内容注释不显示的问题。这个问题通常是由于配置不当或者使用方法错误导致的。Swagger是流行的一款用于构建RESTful API的文档工具，它与...
swagger返回数据注解.zip
12-17
这个压缩包文件“swagger返回数据注解.zip”很可能包含了如何使用 Swagger 注解来定义和展示 API 返回的数据的相关资料。 Swagger 注解主要用在 Java 类和方法上，以便在 Swagger 文档中生成相应的描述。以下是一些...
关于Swagger@ApiModel返回内容注释不显示问题
qq_25635131的博客
10-23 4028
处理swagger返回值的时候返回VO不显示备注，乘了一波凉，先贴出别人栽的树：原文链接https://blog.csdn.net/qq_32917699/article/details/81486060 今天做了一天@ApiModel希望Swagger生成的文档出现返回的内容注释，发现需要用到@ApiModel注解到你需要返回的类上 @ApiModelProperty作为字段的描述 例如 之后文...
在swagger上生成关于json数据类型返回结果的描述
qq_31601531的博客
10-23 9226
在swagger上生成关于json数据类型返回结果的描述 注解ApiReturnJsonObject表示返回结果的map结构 package com.test.swagger2; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.Re...
Swagger接口返回JSON,Map的字段注释比较优雅的实现
austindev的博客
08-05 3699
看很多小伙伴写的接口，既想要Map的灵活扩展性，又苦于生成的接口文档没办法把已知的字段解释清楚；导致接口文档效果打折扣，还得另行约定文档，或者直接嘴上沟通了事；目前使用Swagger2形成接口文档时，当系统设计的接口返回的类型不是实体对象时，Swagger2无法在接口文档页面中显示返回结果字段说明，比如返回json、map等可以存储key-val形式的类型；均无法在接口文档页面上显示返回的字段备注说明；所以怎么才能像实体对象一样显示正常的model字段说明是我们这次需要解决的问题；...
Swagger显示返回参数的说明注释 Swagger给参数加注释
IT大神帅杰的博客
08-17 4222
要实现的效果 1、 VO属性： @ApiModelProperty("") 2、方法返回：VO
Java使用swagger时显示实体类注解问题
老码农的博客
04-28 1万+
第一步，在实体类中@ApiModel(description= “表名描述”) 第二步，在字段属性中@ApiModelProperty(value = “字段备注”) 第三步，在controller中必须增加泛型属性，否则不会显示备注，例如： @RequestMapping(value = “/getAllPosition”, method = RequestMethod.GET) @Respon...
swagger 返回参数注解
小石头
12-17 8570
第一种 @ApiOperation(value = "取消/流失列表") @GetMapping("/getStudentLoseList") @ApiImplicitParams({ @ApiImplicitParam(paramType = "query", name = "type", value = "类型（0:取消分班 1:流失）",required = true,dataType = "int"), @ApiImplicitParam(paramType = "query".
springboot控制接口返回的字段_springBoot 整合 swagger 展示返回对象的嵌套属性文档注释...
weixin_39876650的博客
01-16 781
spring boot 处理 swagger 嵌套数据展示在开发的过程中,我们会常常使用swagger做我们的在线文档.我们会在对象的属性上使用@ApiModelProperty 等api注解,但是遇到对象嵌套的时候,如何返回一个嵌套的json文档就需要我们做一些简单的处理如果只在对象某个属性上使用 @ApiModelProperty 并不会起作用1234567891011121314151617...
Swagger文档显示中文注释
qq_46368587的博客
01-20 2563
1，点击项目【属性】——>【生成】勾选XML文档文件，选择输出路径 取消显示警告添加【;1591】，否则会有警告，不添加也可 2.修改startup 添加代码，其xmlpath的参数"APIDemo.xml" 为上图所选择的xml文档文件。 var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location); //获取应用程序所在目录（绝对，不受工作目录影响，建议采用此方法获取路径） var xmlPath = P.
Swagger给返回参数添加注释说明
热门推荐
qq_25983579的博客
02-27 4万+
处理效果 第一步,控制层加上注解 @ApiResponses({ @ApiResponse(code = 200,message = "OK",response = TrainUserTEntity.class), }) 第二步,实体类属性上面加上注解 @ApiModelProperty(value = "姓名", required = true) ...
SpringBoot整合Swagger与统一返回结果问题
傅老师的博客
07-08 2322
写此博客，以此留念，解决了因使用统一返回结果对象导致，swagger-ui看不到返回对象属性注释的原因。（没有使用泛型导致） Springboot统一结果返回对象 @Data @ApiModel("统一API响应结果封装") public class DataResult<T> { /**操作结果 0为成功*/ @ApiModelProperty("操作结果 0为成功") private int status = 200; /**错误co...
Swagger入门到精通：打造企业级RESTful API神器
Swagger指南深入解析 Swagger, 作为全球最受欢迎的API开发框架，自2016年起与OpenAPI Initiative (OAI) 结合，成为了OpenAPI Specification（简称OAS）的基础。这个强大的工具集不仅提供API文档编写，还支持生成...
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值