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

最新推荐文章于 2023-06-28 15:56:56 发布
原创 最新推荐文章于 2023-06-28 15:56:56 发布 · 6.7k 阅读 · 4 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#java

本文介绍了一种通过封装组合实体类来优化Swagger中文注释显示的方法，适用于需要向前端返回多个列表对象数据的场景。通过自定义组合类并正确定义泛型，可以确保Swagger上字段的中文注释清晰展示，提升API文档的可读性和维护性。

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

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

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

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

fastapi给swagger在线接口文档添加参数注释与示例
ithongchou的博客
08-08 1383
在使用 FastAPI 或者其他支持 Pydantic 的框架时，这些示例值会被用来生成 API 文档，并在文档中展示请求体的示例数据，从而帮助用户了解请求体的结构和字段的预期格式。参数用于为请求体（Body）的数据添加示例，这对于生成 API 文档时展示请求体数据的结构和格式非常有用。），这些描述信息也会在生成的 API 文档中显示出来，帮助用户理解请求体的结构和用途。路由的详细说明，包括请求体的结构和示例数据，这些示例数据就是通过。信息来生成 API 文档，并在文档中展示请求体的示例数据。
swagger3注解用法详解.使用文档
进阶杂货铺
09-04 2729
（它已经包含在springdoc-openapi-ui依赖项中）。注释的包是io.swagger.v3.oas.annotations。
Swagger显示中文注释
qq_60147611的博客
06-28 911
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 1507
记录一下接口返回List类型时404的问题 解决方案:相应接口添加 @ResponseBody注解
把swagger都整懵逼的返回对象
weixin_38390086的博客
12-31 1486
java.lang.reflect.Type 及其子类的应用与学习 ParameterizedType，GenericArrayType，WildcardType，WildcardType
swagger 返回参数注解
小石头
12-17 9302
第一种 @ApiOperation(value = "取消/流失列表") @GetMapping("/getStudentLoseList") @ApiImplicitParams({ @ApiImplicitParam(paramType = "query", name = "type", value = "类型（0:取消分班 1:流失）",required = true,dataType = "int"), @ApiImplicitParam(paramType = "query".
swagger @ApiModel 返回内容注释不显示问题
11-17
在使用Swagger进行API文档自动化生成时，可能会遇到`@ApiModel`注解的返回内容注释不显示的问题。这个问题通常是由于配置不当或者使用方法错误导致的。Swagger是流行的一款用于构建RESTful API的文档工具，它与...
精选资源
swagger返回数据注解.zip
12-17
这个压缩包文件“swagger返回数据注解.zip”很可能包含了如何使用 Swagger 注解来定义和展示 API 返回的数据的相关资料。 Swagger 注解主要用在 Java 类和方法上，以便在 Swagger 文档中生成相应的描述。以下是一些...
swagger返回map字段注释
小白菜
05-04 1万+
1.效果图如下： 2.controller层代码： import java.util.HashMap; import java.util.Map; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.RequestMapping; impor...
swagger-file-generator:根据jsdoc注释生成swagger文件
04-25
Swagger 文件生成器正是利用这些注释，解析出 API 的元数据，然后生成符合 Swagger 规范的文件。 使用 Swagger 文件生成器的过程大致如下： 1. **安装**：首先，你需要在项目中安装该工具，通常通过 npm（Node.js ...
swagger返回数据说明字段注释说明（已解决）
sgycoder的博客
11-18 2万+
本人开发时跟前端对接，swagger没有右侧的注释被吐槽了，查了半天发现是没有给返回值ResponseEntity定义泛型 没有泛型就没有注释说明 不过前提是实体类配置 @ApiModelProperty() 如果能帮到你，就给点个赞吧。谢谢！！ ...
get api list from swagger file
wxqanl的专栏
02-26 184
get api list from sagger file # -*- coding: utf-8 -*- import json from xml.dom import minidom import shutil import time import sys import csv print(sys.getdefaultencoding()) reload(sys) sys.setdef...
Swagger接口返回JSON,Map的字段注释比较优雅的实现
austindev的博客
08-05 4258
看很多小伙伴写的接口，既想要Map的灵活扩展性，又苦于生成的接口文档没办法把已知的字段解释清楚；导致接口文档效果打折扣，还得另行约定文档，或者直接嘴上沟通了事；目前使用Swagger2形成接口文档时，当系统设计的接口返回的类型不是实体对象时，Swagger2无法在接口文档页面中显示返回结果字段说明，比如返回json、map等可以存储key-val形式的类型；均无法在接口文档页面上显示返回的字段备注说明；所以怎么才能像实体对象一样显示正常的model字段说明是我们这次需要解决的问题；...
关于Swagger的@ApiModel 返回内容注释不显示问题解决方案
玩转Java
04-27 9125
使用统一的返回封装类。
Swagger显示返回参数的说明注释 Swagger给参数加注释
IT大神帅杰的博客
08-17 4426
要实现的效果 1、 VO属性： @ApiModelProperty("") 2、方法返回：VO
swagger查询结果中注释不显示问题
JUST DO IT，就是干IT！
12-01 4054
基本的注解不多说了，大家都会，注意点就是controller层的返回结果，如果包装了泛型，需要明确指出，如下图红框 注：如果红框中直接写为Object 返回值什么都正常，但是字段注解不会显示
SpringBoot配置Swagger接口文档参数及返回值注释详细操作
热门推荐
weixin_44906271的博客
04-27 3万+
目录SpringBoot中配置SwaggerSwagger常用注解测试注解用途用实体类接收参数或者返回数据配置 SpringBoot中配置Swagger 1. 导入依赖 官方推荐里说只需要前面两个依赖就可以了，但实测只导入上面两个依赖的话，后台会报依赖，网上查询加上下面两个依赖后不报异常了，原因未知。 <dependency> <groupId>io.spring...
Java使用swagger时显示实体类注解问题
老码农的博客
04-28 1万+
第一步，在实体类中@ApiModel(description= “表名描述”) 第二步，在字段属性中@ApiModelProperty(value = “字段备注”) 第三步，在controller中必须增加泛型属性，否则不会显示备注，例如： @RequestMapping(value = “/getAllPosition”, method = RequestMethod.GET) @Respon...
springboot控制接口返回的字段_springBoot 整合 swagger 展示返回对象的嵌套属性文档注释...
weixin_39876650的博客
01-16 856
spring boot 处理 swagger 嵌套数据展示在开发的过程中,我们会常常使用swagger做我们的在线文档.我们会在对象的属性上使用@ApiModelProperty 等api注解,但是遇到对象嵌套的时候,如何返回一个嵌套的json文档就需要我们做一些简单的处理如果只在对象某个属性上使用 @ApiModelProperty 并不会起作用1234567891011121314151617...
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值