Swagger java中隐藏不想返回的字段信息

最新推荐文章于 2024-08-01 18:00:57 发布
最新推荐文章于 2024-08-01 18:00:57 发布
阅读量1.5k 收藏 1
点赞数
文章标签： spring boot swagger
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u012374381/article/details/129286947
版权

使用ApiModelProperty hidden = true ，文档屏蔽了，前端还是能接收到参数

场景：有时候我们返回给前端的数据是包含null的，而这些为null的值前端也不好处理，所以我们就没必要把null值返回给前端，

一般登录都会用到账号和密码，这时隐藏密码字段也是常规操作了

操作：设置某些字段不返回前端（如密码等敏感信息）

@JSONField(serialize = false)
private String password;

一：我这里使用的是阿里的fastjson，这里采用 @JSONField(serialize = false)注解

二：如果是jackson的话，采用 @JsonIgnore 注解

八年程序员下岗落魄一年
关注
swagger隐藏实体类字段_swagger基本使用
weixin_42510717的博客
01-06 7497
关于 SwaggerSwagger能成为最受欢迎的REST APIs文档生成工具之一，有以下几个原因：mSwagger 可以生成一个具有互动性的API控制台，开发者可以用来快速学习和尝试API。Swagger 可以生成客户端SDK代码用于各种不同的平台上的实现。Swagger 文件可以在许多不同的平台上从代码注释中自动生成。Swagger 有一个强大的社区，里面有许多强悍的贡献者。Sw...
java----swagger隐藏入参中属性字段解决办法
别看，很懒，随心
08-20 4302
一次偶然需求，有个别字段是给后端自己用的，不想在前端显示，网上有许多说设置一下 @ApiModelProperty( hidden = true) 就行，但是试了并没用，现有来看必须得自己重写部分源码实现注解 第一步： 创建swagger2要忽略的注解 import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; impo
swagger @ApiModel 返回内容注释不显示问题
11-17
swagger @ApiModel 返回内容注释不显示问题 展开无类信息
swagger文档屏蔽字段、swagger忽略字段
木辰風的博客
08-01 433
@ApiModelProperty 注解增加 hidden = true。如果想不展示这个字段 用 这个注解。 @JsonIgnore 如果想不展示这个字段 用 这个注解
swagger 忽略字段
weinichendian的博客
11-27 7860
大家好，我是入错行的bug猫。（http://blog.csdn.net/qq_41399429，谢绝转载） 如题，swagger的ApiModel中，如何忽略不需要的字段呢？ @ApiIgnore？这个没毛病，因为整个方法都被忽略了，对应的ApiModel都不显示了，有木有…… @ApiParam(hidden = true) ？可以吗？可以就见鬼了！ @ApiModelProperty...
Spring Boot demo系列（六）：Swagger
氷泠
09-23 546
1 概述 Swagger主要用于生成API文档，本文演示了如何使用目前最新的OpenAPI3以及Swagger来进行接口文档的生成。 2 依赖 <dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-ui</artifactId> <version>1.4.7</version> </dependen
swagger隐藏实体类字段_swagger2自定义隐藏实体类属性，swagger2版本2.8.0
weixin_39636608的博客
12-22 2777
博主将这个功能做了个组件，不想在项目中修改源码的请移步另一篇博客假如接收参数的实体类中关联了其他对象，那么swagger2的页面中参数应该会多出来这些，dept.id，dept.deptName，或者集合属性，roles[0].id，roles[0].roleName等等。​​​这些属性有可能是不需要用来接收参数的，出现在文档中会给前端开发人员带来困惑 笔者在swagger2提供的配置中没有找到隐...
关于使用Swagger-ui时文档显示实体类中隐藏部分字段的问题
m0_49316283的博客
03-24 2781
关于使用Swagger-ui时文档显示实体类中隐藏部分字段的问题 所遇到的问题： 在swagger-ui测试页面测试接口时，由于在实体类中添加部分临时的实体类导致测试文档过于冗杂 解决： pom.xml添加依赖： <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version&gt
swagger隐藏实体类字段_Swagger2 隐藏实体中关联的对象
weixin_27012835的博客
01-13 2033
这里提供的是swagger2版本2.8.0 的解决方案看了网上的一些自定义的，但是有些不全面。通过阅读源码找到了展开参数的类springfox.documentation.spring.web.readers.parameter.ModelAttributeParameterExpander，笔者通过继承这个类，并添加@Primary注解覆盖了源码中的逻辑，修改了getBeanPropertyNa...
springboot 返回给前端不必要的字段如何处理
12-14
首先，我们理解问题的核心在于后端返回了前端并不需要的所有字段。这可能导致网络传输的数据量过大，增加延迟，同时也可能使前端解析数据时复杂度提升。因此，我们需要根据前端的需求定制返回的字段。 **第一步：...
swagger忽略某些不想显示在文档中的字段
qq_25983579的博客
05-28 1万+
//方法一:在ApiModelProperty中添加hidden=true @ApiModelProperty(value = "所属机构", required = false,hidden=true) private String createUserOrgNo; //方法二:@JsonIgnore增加@JsonIgnore注解 @ApiModelProperty(value = "自增序列", required = false) @JsonIgnore private .
swagger2搭配knife4j 隐藏实体类的属性/字段
qq_45900875的博客
07-04 1928
swagger2搭配knife4j 隐藏实体类的属性/字段
​指定字段不显示在Swagger文档中​
xiuxiuzhuanshu的博客
07-07 2659
问题：忽略某些参数，使其不显示在接口文档中解决：使用swagger提供的@ApiModelProperty参数，如下： @ApiModelProperty(hidden = true) private Long userId;
swagger(三)：统一返回结果不显示字段说明
热门推荐
风之子
01-29 1万+
1. 正常显示情况 正常情况下,不管是调试还是文档说明都会显示以上字段说明。 2. 非正常情况 2.1 返回Object 不显示 响应参数不显示字段属性： 2.2 返回Map不显示 为何返回Map不显示,大家都知道Map是Java里面的集合接口,不管是Map本身还是诸如HashMap等子实现,这类数据对于Swagger来说都是未定义结构的数据 Swagger只认识定义好的类-属性，所以接口返回Map,对于Swagger来说是没有字段展示的,这种情况同样适用与返回Object这...
swagger2.7隐藏入参中属性字段解决办法
qi923701的博客
01-01 4949
第一步： 创建swagger2要忽略的注解 package com.example.annotation; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang...
Swagger隐藏接口
Ellan的博客
03-17 1525
Swagger隐藏接口
如何隐藏后端返回字段给前端
weixin_45820558的博客
04-26 555
如果是jackson包的话,使用在索要隐藏的属性加上@JsonIngnore的注解就OK。注意这个JSONField只针对的是fastjson包。
swagger 忽略字段swagger 指定字段不显示到文档里
05-11 3219
@JsonIgnore // 如果想不展示这个字段 用 这个注解
swagger 如何隐藏model某个字段
最新发布
09-10
如果你想在使用 Swagger 的项目中隐藏某个 Model 的某个字段，可以在该字段对应的实体类的字段上使用 Swagger 提供的注解来实现。常用的注解有 `@ApiModel`、`@ApiModelProperty` 和 `@JsonIgnore` 等。其中，`@...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值