Knife4j指定属性不显示在文档上
如果想让指定的属性在 Knife4j
文档中不显示为参数,可以通过使用 @Schema(hidden = true)
注解来隐藏该字段。
这样在生成的 API 文档中,这个字段将不会显示为参数。
示例如下:
import io.swagger.v3.oas.annotations.media.Schema;
public class WorkQueryVo {
@Schema(description = "模糊查询参数")
private String query;
@Schema(hidden = true) // 隐藏 userId 属性
private Long userId;
@Schema(description = "作者id")
private Long authorId;
@Schema(description = "排序键")
private String orderBy;
@Schema(description = "排序方式(1升序,2降序,默认降序)")
private OrderType orderType;
// Getters and setters
}
解释
@Schema(hidden = true)
: 通过这个注解,可以隐藏userId
属性,使其不在 API 文档中显示。
分类:
后端 / SpringBoot
【推荐】国内首个AI IDE,深度理解中文开发场景,立即下载体验Trae
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· 全程不用写代码,我用AI程序员写了一个飞机大战
· DeepSeek 开源周回顾「GitHub 热点速览」
· 记一次.NET内存居高不下排查解决与启示
· 物流快递公司核心技术能力-地址解析分单基础技术分享
· .NET 10首个预览版发布:重大改进与新特性概览!
2023-08-14 Error: error:0308010C:digital envelope routines::unsupported
2023-08-14 leaflet.js气象风场图制作