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

    @ApiModel

    使用场景

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

    概述

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

    属性

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

    @ApiModelProperty

    使用场景

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

    概述

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

    属性

    属性名称 数据类型 默认值 说明
    value String “” 属性简要说明
    name String “” 运行覆盖属性的名称。重写属性名称
    allowableValues String “” 限制参数可接收的值，三种方法，固定取值，固定范围
    access String “” 过滤属性，参阅:io.swagger.core.filter.SwaggerSpecFilter
    notes String “” 目前尚未使用
    dataType String “” 参数的数据类型，可以是类名或原始数据类型，此值将覆盖从类属性读取的数据类型
    required boolean false 是否为必传参数,false:非必传参数; true:必传参数
    position int 0 允许在模型中显示排序属性
    hidden boolean false 隐藏模型属性，false:不隐藏; true:隐藏
    example String “” 属性的示例值
    readOnly boolean false 指定模型属性为只读，false:非只读; true:只读
    reference String “” 指定对应类型定义的引用，覆盖指定的任何其他元数据
    allowEmptyValue boolean false 允许传空值，false:不允许传空值; true:允许传空值

    Swagger踩坑@ApiModel注解问题

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

    补充：

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

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

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

    声明：本站所有文章，如无特殊说明或标注，均为本站原创发布。任何个人或组织，在未征得本站同意时，禁止复制、盗用、采集、发布本站内容到任何网站、书籍等各类媒体平台。如若本站内容侵犯了原著者的合法权益，可联系我们进行处理。