首页 > 其他分享 >Knife4j指定属性不显示在文档上

Knife4j指定属性不显示在文档上

时间:2024-08-14 22:37:41浏览次数:6  
标签:Knife4j description userId private 文档 属性 Schema

如果想让指定的属性在 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 文档中显示。

标签:Knife4j,description,userId,private,文档,属性,Schema
From: https://www.cnblogs.com/echohye/p/18359900

相关文章

  • PDF编辑神器!这四款福昕PDF,让文档编辑变得如此简单
    每天不管是工作还是在学习以及日常当中,遇到的PDF文件量很大并且需要面临的文件转换、编辑和阅读中需要的下划线、批注等等都是很常见的,所以今天借此文章,整理了手里用过的四款好用的福昕PDF工具,大家一起来探讨我们国产老大哥旗下的优质PDF工具:第一款:福昕编辑大师直通车(粘贴到......
  • 基于SpringBoot的心理健康管理系统的设计与实现(源码+LW+调试文档)
    目录:程序视频演示:程序技术介绍:后端springboot介绍:mysql介绍:程序功能截图:程序部分代码参考:数据库sql:程序论文:​选择我的理由:程序获取:......
  • 7.接口文档,JWT介绍
    【一】接口文档1)公司使用使用world编写MD共享文档第三方平台:如:https://www.showdoc.com.cn/公司自研2)主要内容如下说明变更记录全局错误相关接口简要描述请求URL请求方式参数返回示例返回参数说明备注3)字段生成(coreapi使用)安装pipinstal......
  • Java 入门指南:字段(成员变量或属性)
    引言在Java编程中,字段(也称为成员变量或属性)是类的重要组成部分,它们用于存储对象的状态信息。理解Java字段的各个方面对于编写高效、可维护的Java代码至关重要。字段的定义与特性字段是类中声明的变量,它们可以是任何类型,包括基本数据类型(如int、double)和引用类型(如String......
  • 基于SpringBoot+VUE的学生心理咨询评估系统(源码+文档+部署)
    主要内容:Java项目、Python项目、前端项目、PHP、ASP.NET、人工智能与大数据、单片机开发、物联网设计与开发设计、简历模板、学习资料、面试题库、技术互助、就业指导等业务范围:免费功能设计、开题报告、任务书、中期检查PPT、系统功能实现、代码编写、论文编写和辅导、论......
  • Delphi编程艺术:注释技巧与文档自动化
    标题:Delphi编程艺术:注释技巧与文档自动化引言在Delphi开发中,注释和文档生成是编写可维护代码的基础。Delphi支持多种注释方式,同时提供了工具和方法来自动化文档的生成。本文将详细介绍Delphi中的注释类型,以及如何使用Delphi生成Word文档等自动化文档的技巧。Delphi中的注......
  • 15.画盒子,文字修饰属性,行高
    一.画盒子 顾名思义就是在浏览器插入一个四方形,宽高随意,那这个要如何操作呢,记得之前学过的无语义标签不,我们可以用<div>标签来画盒子,具体如何操作:<!DOCTYPEhtml><htmllang="en"><head><metacharset="UTF-8"><metaname="viewport"content="width......
  • SSM基于的物流系统4x007 带论文文档1万字以上
    本系统(程序+源码+数据库+调试部署+开发环境)带论文文档1万字以上,文末可获取,系统界面在最后面。系统程序文件列表系统内容:快递员,业务员,车辆信息,申请车辆,归还车辆,发货信息,派件信息,区域编号,仓库货物,合作伙伴,物流信息,目的仓库,派件确认,仓库编号,快递员考核,业务员考......
  • SSM基于的社区疫情防控管理信息系统的设计与实现khjit 本系统(程序+源码+数据库+调试部
    本系统(程序+源码+数据库+调试部署+开发环境)带论文文档1万字以上,文末可获取,系统界面在最后面。系统程序文件列表系统内容:居民,核酸检测,检测预约,检测记录,健康上报,出入信息,物品申请,物品派送开题报告内容一、课题背景与意义随着全球新冠疫情的持续蔓延,社区疫情防控成为......
  • JAVA毕业设计|ssm高校宿舍管理系统的设计与开发jsp包含文档代码讲解
    收藏点赞不迷路 关注作者有好处文末获取源码一、系统展示二、万字文档展示 基于ssm高校宿舍管理系统的设计与开发jsp开发语言:Java数据库:MySQL技术:Spring+SpringMVC+MyBatis+Vue工具:IDEA/Ecilpse、Navicat、Maven 编号:ssm283一、系统展示二、万字文档展示第......