@ApiModelProperty用法

最新推荐文章于 2026-05-18 07:02:44 发布

原创最新推荐文章于 2026-05-18 07:02:44 发布 · 7k 阅读

3 ·

本内容遵循CC 4.0 BY-SA版权协议

收录于

本文详细介绍了ApiModelProperty注解的使用方法，包括value、name、allowableValues等7个关键属性的作用及示例，帮助开发者更好地理解和应用该注解。

@ApiModelProperty用法

1、value()

	此属性的简要说明。

2、name()

	允许覆盖属性的名称。

3、allowableValues()

	限制此参数的可接受值。列如：@ApiModelProperty(value = "状态,0:禁用、1:启用", dataType = "Integer", allowableValues = "0,1")

4、dataType()

	参数的数据类型。

5、allowEmptyValue()

	允许传递空值，默认false

6、example()

	属性的样本值。

7、hidden()

	允许模型属性隐藏在Swagger模型定义中。

确定要放弃本次机会？

福利倒计时

: :

立减 ¥

普通VIP年卡可用

立即使用

喜欢敲代码的程序猿

关注关注

2
点赞
踩
3

收藏

觉得还不错? 一键收藏
0
评论
分享

复制链接

分享到 QQ

分享到新浪微博

扫一扫
举报

举报

Swagger中配置了@ApiModelProperty的allowableValues属性但不显示的问题

qq_34412985的博客

09-13

1805

现在用Swagger来生成API文档的例子已经非常多了，今天碰到开发同事问了一个问题，帮着看了一下，主要还是配置方法的问题，所以记录一下。如果您也碰到了同样的问题，希望本文对您有用。问题描述 @ApiModelProperty注解是用来给属性标注说明、默认值、是否可以为空等配置使用的，其中有一个属性allowableValues是本文要讲的重点，从属性命名上就能知道，该属性用来配置所标注字段允许的可选值。但是这个属性是一个String类型，我们要如何配置可选值呢？我们可以通过源码的注释了解到一

参与评论您还未登录，请先登录后发表或查看评论

@ApiModelProperty：Swagger 文档中的关键注解

一起coding，一起嗨。

11-28

1692

@ApiModelProperty：Swagger 文档中的关键注解

HFSS扫频设置保姆级教程：从时域信号反推扫频范围到SPICE模型导出

热门推荐

weixin_44356055的博客

11-02

16万+

1、value() 源码：String value() default ""; 参数类型为String，作用为此属性的简要描述。 2、name() 源码： String name() default ""; 参数类型为String，作用为允许重写属性的名称。 3、allowableValues() 源码：String allowableValues() default ""; 参数类型为String，作用为限制此参数存储的长度。 4、access() 源码：String access()

@ApiModelProperty

weixin_44294686的博客

12-08

5984

@ApiModelProperty()用于方法，字段；表示对model属性的说明或者数据操作更改 value–字段说明 name–重写属性名字 dataType–重写属性类型 required–是否必填 example–举例说明 hidden–隐藏 @ApiModel(value="user对象",description="用户对象user") public class User implements Serializable{ private static final long serial

@ApiModel和@ApiModelProperty用法

2301_79125642的博客

12-15

1083

镇子中有各式各样的舞台和摊位，有跳舞的、讲脱口秀的、画画的，也有卖各种新鲜玩意儿的（比如4米长的大刀，打开快递。投票中的n约等于15w1，电网挺稳的，不会被裁，也加班，平常865，加班不定时。收到合肥南瑞中天的解决方案工程师的offer，网上的相关信息太少了，想问问有没有坑啊，加班和出差多不多，hr说的靠谱不？两天后一看，被调剂到了莱芜的售后。楼主山东人，经过今年惨淡的秋招，得到了几个offer，其中也有国企，也有私企，最后待遇比较去了私企，但这事被家里亲戚知道后，大骂我糊涂，私企干一段时间就倒闭了，

@ApiModelProperty的用法

那些年的代码

04-25

2万+

详解JAVA中的@ApiModel和@ApiModelProperty注解

码农研究僧的博客

12-07

2万+

在Java中，@ApiModel和@ApiModelProperty是Swagger框架（用于API文档的工具）提供的注解，用于增强API文档的生成和展示。这两者搭配使用更佳。主要作用：开发者对API的模型和属性进行详细的描述，以便生成清晰的API文档

@ApiModel注解与@ApiModelProperty注解

weixin_51351637的博客

03-12

2万+

在 ApiModelProperty 注解中直接声明 allowEmptyValue属性的值即可，如果不声明该属性，则默认为false，即字段参数的值不可以为空。具体使用就如上面的例子一样，如果不使用value时，默认值就是实体类的名称，所以除非有特殊说明或者实体类不清晰，否则直接使用默认值即可。属性就是用来描述实体中的参数字段是否必传,默认false，如果使用true，则该字段后面会有一个红色的星号。上的注解，它主要是用来对使用该注解的接口相关的实体类。上的注解，用来对具体的接口相关实体类中的。

@ApiModelProperty注解

weixin_58276266的博客

12-10

2万+

@ApiModelProperty()用于方法，字段；表示对model属性的说明或者数据操作更改 value–字段说明 name–重写属性名字 dataType–重写属性类型 required–是否必填 example–举例说明 hidden–隐藏

@ApiModelProperty等不同的注解方法

scott198512的博客

12-13

3698

java 注解的几种用法 @qualsAndHashCode

@Api @ApiOperation @ApiModel @ApiModelProperty——Swagger常用注解

global_coding的博客

03-30

4252

@Api @ApiOperation @ApiModel @ApiModelProperty Swagger 注解

@ApiModelProperty的使用

weixin_43898002的博客

02-16

8678

@ApiModelProperty的使用ApiModelProperty注解代码片段结语 ApiModelProperty注解 @ApiModelProperty一般用于给入参属性添加说明时使用： value：字段说明 name：重写属性名字 dataType：重写属性类型 required：是否必填（true为必填） example：举例说明 hidden：隐藏（true为隐藏）代码片段使用了@Data所以可以省略get set，@ApiModel用于标注该类是用于那个功能模块，用于说明。下面代

Swagger 大坑之 @ApiModelProperty 注解的大坑

m0_37856386的博客

03-16

4641

swagger页面上突然少了一个接口集：@ApiModelProperty注解是不能修饰public修饰的类属性的；

@ApiModel 和 @ApiModelProperty

qq_43611698的博客

12-24

2万+

@ApiModel 使用场景：在实体类上边使用，标记类时swagger的解析类 1.什么是Swagger OpenAPI规范（OpenAPI Specification 简称OAS）是Linux基金会的一个项目，试图通过定义一种用来描述API格式或API定义的语言，来规范RESTful服务开发过程，目前版本是V3.0，并且已经发布并开源在github上。 Swagger是符合OpenAPI规范的接口开发工具，支持从设计和文档到测试和部署的整个API生命周期的开发概述提供有关swagge.