信息发布→ 登录 注册 退出

Swagger注解-@ApiModel和@ApiModelProperty的用法

发布时间:2026-01-11

点击量:
目录
  • @ApiModel
    • 使用场景
    • 概述
    • 属性
  • @ApiModelProperty
    • 使用场景
    • 概述
    • 属性
  • Swagger踩坑@ApiModel注解问题

    @ApiModel

    使用场景

    在实体类上边使用,标记类时swagger的解析类

    概述

    提供有关swagger模型的其它信息,类将在操作中用作类型时自动内省

    属性

    属性名称数据类型默认值说明
    valueString类名为模型提供备用名称
    descriptionString“”提供详细的类描述
    parentClass<?> parentVoid.class为模型提供父类以允许描述继承关系
    discriminatoryString“”支持模型继承和多态,使用鉴别器的字段的名称,可以断言需要使用哪个子类型
    subTypesClass<?>[]{}从此模型继承的子类型数组
    referenceString“”指定对应类型定义的引用,覆盖指定的任何其他元数据

    @ApiModelProperty

    使用场景

    使用在被 @ApiModel 注解的模型类的属性上

    概述

    添加和操作模型属性的数据

    属性

    属性名称数据类型默认值说明
    valueString“”属性简要说明
    nameString“”运行覆盖属性的名称。重写属性名称
    allowableValuesString“”限制参数可接收的值,三种方法,固定取值,固定范围
    accessString“”过滤属性,参阅:io.swagger.core.filter.SwaggerSpecFilter
    notesString“”目前尚未使用
    dataTypeString“”参数的数据类型,可以是类名或原始数据类型,此值将覆盖从类属性读取的数据类型
    requiredbooleanfalse是否为必传参数,false:非必传参数; true:必传参数
    positionint0允许在模型中显示排序属性
    hiddenbooleanfalse隐藏模型属性,false:不隐藏; true:隐藏
    exampleString“”属性的示例值
    readOnlybooleanfalse指定模型属性为只读,false:非只读; true:只读
    referenceString“”指定对应类型定义的引用,覆盖指定的任何其他元数据
    allowEmptyValuebooleanfalse允许传空值,false:不允许传空值; true:允许传空值

    Swagger踩坑@ApiModel注解问题

    @ApiModel内的注释 不要出现相同   否则会将相同的vo内的字段进行合并  

    补充:

    @ApiModel(description = "码农") description内的值 不要相同就可以避免

    例如改为:@ApiModel(description = "码农2")

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

    在线客服
    服务热线

    服务热线

    4008888355

    微信咨询
    二维码
    返回顶部
    ×二维码

    截屏,微信识别二维码

    打开微信

    微信号已复制,请打开微信添加咨询详情!