返回顶部
首页 > 资讯 > 后端开发 > Python >SpringBoot中的@ApiModelProperty注解作用
  • 637
分享到

SpringBoot中的@ApiModelProperty注解作用

2024-04-02 19:04:59 637人浏览 泡泡鱼

Python 官方文档:入门教程 => 点击学习

摘要

目录@apiModelProperty注解作用主要字段说明举个简单的例子@ApiModelProperty()失效解决方法@ApiModelProperty注解作用 @ApiMode

@ApiModelProperty注解作用

@ApiModelProperty()注解用于方法、字段,表示对model属性的说明或者数据操作更改,以下是它的源码

 
  // IntelliJ API Decompiler stub source generated from a class file
  // Implementation of methods is not available 
package io.swagger.annotations; 
@java.lang.annotation.Target({java.lang.annotation.ElementType.METHOD, java.lang.annotation.ElementType.FIELD})
@java.lang.annotation.Retention(java.lang.annotation.RetentionPolicy.RUNTIME)
public @interface ApiModelProperty {
    java.lang.String value() default ""; 
    java.lang.String name() default ""; 
    java.lang.String allowableValues() default ""; 
    java.lang.String access() default ""; 
    java.lang.String notes() default ""; 
    java.lang.String dataType() default ""; 
    boolean required() default false; 
    int position() default 0; 
    boolean hidden() default false; 
    java.lang.String example() default "";
 
    
    @java.lang.Deprecated
    boolean readOnly() default false; 
    io.swagger.annotations.ApiModelProperty.AcceSSMode accessMode() default io.swagger.annotations.ApiModelProperty.AccessMode.AUTO; 
    java.lang.String reference() default ""; 
    boolean allowEmptyValue() default false; 
    io.swagger.annotations.Extension[] extensions() default {@io.swagger.annotations.Extension(properties = {@io.swagger.annotations.ExtensionProperty(name = "", value = "")})}; 
    static enum AccessMode {
        AUTO, READ_ONLY, READ_WRITE; 
        private AccessMode() {  }
    }
}

主要字段说明

  • value:字段说明
  • name:重写属性名字
  • dataType:重写属性类型
  • required:是否必须,默认false
  • example:举例
  • hidden:隐藏

举个简单的例子

@ApiModel(value="user", description="users")
public class UserVO implements Serializable{    
    private static final long serialVersionUID = 1L;    
     @ApiModelProperty(value="用户名", name="username", example="xzw")
     private String username;     
     @ApiModelProperty(value="状态", name="status", required=true)
      private Integer status;
      private String pwd;
      private String nName;
      private Integer flag;
 
      @ApiModelProperty(value="grade数组", hidden=true)
      private String[] grades;
      private List<String> gradeList;
}

@ApiModelProperty()失效

解决方法

可以把

@ApiModelProperty(value= "id")

替换成

@ApiModelProperty(example = "id")

即可~

以上为个人经验,希望能给大家一个参考,也希望大家多多支持编程网。

--结束END--

本文标题: SpringBoot中的@ApiModelProperty注解作用

本文链接: https://lsjlt.com/news/162084.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

猜你喜欢
  • SpringBoot中的@ApiModelProperty注解作用
    目录@ApiModelProperty注解作用主要字段说明举个简单的例子@ApiModelProperty()失效解决方法@ApiModelProperty注解作用 @ApiMode...
    99+
    2024-04-02
  • Swagger注解-@ApiModel和@ApiModelProperty的用法
    目录@ApiModel使用场景概述属性@ApiModelProperty使用场景概述属性Swagger踩坑@ApiModel注解问题@ApiModel 使用场景 在实体类上边使用,标...
    99+
    2024-04-02
  • swagger注解@ApiModelProperty失效情况的解决
    目录swagger注解@ApiModelProperty失效swagger 版本 2.29.2解决方式: 小写字段名@ApiModelProperty注解的使用下面是它内部的常用属性...
    99+
    2024-04-02
  • SpringBoot中的@Value注解用法
    目录一、前言二、数组怎么样三、替代方法3.1 解析 List3.2 解析 Set3.3 解析 Map四、后续一、前言 在日常开发中,经常会遇到需要在配置文件中,存储&nbs...
    99+
    2024-04-02
  • SpringBoot中注解@AliasFor的使用详解
    目录简介用法1:注解的属性互为别名简介实例用法2.继承父注解的属性,不重写属性名简介代码用法3:继承父注解的属性,并重写属性名简介代码简介 本文用示例介绍@AliasFor(别名)注...
    99+
    2024-04-02
  • 详解SpringBoot中@ConditionalOnClass注解的使用
    目录一、@ConditionalOnClass注解初始二、@ConditionalOnClass注解用法1、使用value属性2、使用name属性三、@ConditionalOnCl...
    99+
    2022-11-13
    SpringBoot @ConditionalOnClass注解 SpringBoot @ConditionalOnClass SpringBoot 注解
  • springboot常用注解及作用是什么
    Spring Boot 是基于 Spring 框架的快速开发框架,其中常用的注解及作用如下:1. @SpringBootApplic...
    99+
    2023-05-21
    springboot常用注解 springboot
  • Springboot中@RequestBody注解使用的注意事项
    这篇文章将为大家详细讲解有关Springboot中@RequestBody注解使用的注意事项,小编觉得挺实用的,因此分享给大家做个参考,希望大家阅读完这篇文章后可以有所收获。@RequestBody注解踩坑@RequestBody json...
    99+
    2023-06-29
  • java中注解的作用
    本篇文章为大家展示了java中注解的作用,内容简明扼要并且容易理解,绝对能使你眼前一亮,通过这篇文章的详细介绍希望你能有所收获。Java是什么Java是一门面向对象编程语言,可以编写桌面应用程序、Web应用程序、分布式系统和嵌入式系统应用程...
    99+
    2023-06-14
  • SpringBoot中有哪些常用的注解
    这篇文章将为大家详细讲解有关SpringBoot中有哪些常用的注解,文章内容质量较高,因此小编分享给大家做个参考,希望大家阅读完这篇文章后对相关知识有一定的了解。@SpringBootApplication...
    99+
    2024-04-02
  • springboot中@component注解的使用实例
    目录@component注解的使用方式一方式二@component注解有什么作用用一句话概括@component注解的使用 配置响应头的内容。 方式一 直接在拦截器里配置响应头内容。...
    99+
    2024-04-02
  • SpringBoot中@Import注解的使用方式
    目录一、 @Import引入普通类二、 @Import引入配置类(@Configuration修饰的类)三 、@Import引入ImportSelector的实现类3.1 ...
    99+
    2024-04-02
  • SpringBoot中常用的注解有哪些
    这篇文章主要介绍了SpringBoot中常用的注解有哪些,具有一定借鉴价值,感兴趣的朋友可以参考下,希望大家阅读完这篇文章之后大有收获,下面让小编带着大家一起了解一下。一、@SpringBootApplication此注解是Spring B...
    99+
    2023-06-21
  • SpringBoot中的@AliasFor注解怎么使用
    本文小编为大家详细介绍“SpringBoot中的@AliasFor注解怎么使用”,内容详细,步骤清晰,细节处理妥当,希望这篇“SpringBoot中的@AliasFor注解怎么使用”文章能帮助大家解决疑惑,下面跟着小编的思路慢慢深入,一起来...
    99+
    2023-06-30
  • SpringBoot中的@Import注解怎么使用
    这篇文章主要介绍了SpringBoot中的@Import注解怎么使用的相关知识,内容详细易懂,操作简单快捷,具有一定借鉴价值,相信大家阅读完这篇SpringBoot中的@Import注解怎么使用文章都会有所收获,下面我们一起来看看吧。一、 ...
    99+
    2023-06-30
  • 详解SpringBoot的常用注解
    详解SpringBoot的常用注解 在SpringBoot中,注解是一种非常重要的编程方式,它可以简化代码,提高开发效率。本文将详细介绍SpringBoot中的常用注解,以及它们的使用方法和场景。 1. @SpringBootApplica...
    99+
    2023-08-20
    spring boot java mybatis 原力计划
  • SpringBoot Shiro 权限注解不起作用的解决方法
    目录问题如下:解决方法如下:最近在学习springboot结合shiro做权限管理时碰到一个问题。 问题如下: 我在userRealm中的doGetAuthorizationInfo...
    99+
    2024-04-02
  • 详解SpringBoot中@NotNull,@NotBlank注解使用
    目录一.添加依赖二.在类中使用验证注解1.创建验证实体类(嵌套使用)2.创建全局异常处理器,对message信息进行处理,并返回给前端3.在controller中的使用三.在方法参数...
    99+
    2024-04-02
  • Springboot中使用lombok的@Data注解方式
    目录Springboot 使用lombok的@Data注解idea安装lombok插件创建项目,编写实体类编写测试类测试结果springBoot 注解@Data注入失败一、Files--Seetings--Plugins二、如果重启后仍注入...
    99+
    2014-06-11
    Springboot注解 lombok 注解 @Data注解
  • springboot中@component注解如何使用
    这篇文章主要介绍“springboot中@component注解如何使用”,在日常操作中,相信很多人在springboot中@component注解如何使用问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”spr...
    99+
    2023-06-29
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作