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

目录
  • @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")

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

赞 (0)

相关推荐

  • SpringBoot中的@ApiModelProperty注解作用

    目录 @ApiModelProperty注解作用 主要字段说明 举个简单的例子 @ApiModelProperty()失效 解决方法 @ApiModelProperty注解作用 @ApiModelProperty()注解用于方法.字段,表示对model属性的说明或者数据操作更改,以下是它的源码: // IntelliJ API Decompiler stub source generated from a class file // Implementation of methods is no

  • 关于Swagger注释API的使用说明

    目录 API详细说明 示例 @ApiImplicitParam paramType 示例详解 接收对象传参的例子 API详细说明 注释汇总 作用范围 API 使用位置 对象属性 @ApiModelProperty 用在出入参数对象的字段上 协议集描述 @Api 用于controller类上 协议描述 @ApiOperation 用在controller的方法上 Response集 @ApiResponses 用在controller的方法上 Response @ApiResponse 用在 @A

  • swagger @ApiModel添加实体类不生效的解决

    swagger @ApiModel添加实体类不生效的解决

    目录 @ApiModel添加实体类不生效 Models实体类无法显示 解决办法 @ApiModel添加实体类不生效 swagger, @ApiModel, Models, 实体类无法加载 在使用swagger时, 以为加上@ApiModel在实体类上就可以在swagger-ui.html的Models里面显示. 但是我创建了很多实体类, 但怎么也只显示了一个??? Models中无论如何只有User这一个实体类. 后来发现不是加上@ApiModel就可以加入Models中的,必须要在contro

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

    目录 @ApiModel 使用场景 概述 属性 @ApiModelProperty 使用场景 概述 属性 Swagger踩坑@ApiModel注解问题 @ApiModel 使用场景 在实体类上边使用,标记类时swagger的解析类 概述 提供有关swagger模型的其它信息,类将在操作中用作类型时自动内省 属性 属性名称 数据类型 默认值 说明 value String 类名 为模型提供备用名称 description String “” 提供详细的类描述 parent Class<?> pa

  • swagger注解@ApiModelProperty失效情况的解决

    swagger注解@ApiModelProperty失效情况的解决

    目录 swagger注解@ApiModelProperty失效 swagger 版本 2.29.2 解决方式: 小写字段名 @ApiModelProperty注解的使用 下面是它内部的常用属性 swagger注解@ApiModelProperty失效 swagger 版本 2.29.2 解决方式: 小写字段名 @ApiModelProperty注解的使用 首先要知道@ApiModelProperty是swagger的注解,它的作用是添加和操作属性模块的数据 下面是它内部的常用属性 1.value

  • 配置Spring4.0注解Cache+Redis缓存的用法

    前言: 目前公司项目在上一个技术架构的处理,已经搭建好了Redis,但redis只用在了做session的管理,然而 后台的对象缓存没有用上 1. redis 和 ehcache的区别: 简单了解了下,个人觉得 从部署上而言,redis更适合分布式部署,ehcache是在每台应用服务器上开辟一块内存做缓存,集群时还得考虑缓存的情况, redis就不需要考虑缓存了.单独部署在一台服务器中(也可以是在某一台应用服务器中) 2. 项目配置(spring mvc+maven+mybaits+redis)

  • MyBatis官方代码生成工具给力(解放双手)

    MyBatis官方代码生成工具给力(解放双手)

    摘要 在我们使用MyBatis的过程中,如果所有实体类和单表CRUD代码都需要手写,那将会是一件相当麻烦的事情.MyBatis官方代码生成器MyBatis Generator可以帮助我们解决这个问题,在我的开源项目mall中也是使用的这个代码生成器,用习惯了也挺不错的.本文将介绍MyBatis Generator的使用方法及使用技巧,希望对大家有所帮助! 简介 MyBatis Generator(简称MBG)是MyBatis官方提供的代码生成工具.可以通过数据库表直接生成实体类.单表CRUD代码

  • SpringBoot2底层注解@Import用法详解

    SpringBoot2底层注解@Import用法详解

    目录 SpringBoot2注解@Import @Import 导入组件 用法 验证 SpringBoot2注解@Import 上一篇中了解到了@Configuration,可以注册组件.除此之外,还有许多注解也可以,用法跟之前学习 spring 的时候一样.比如,@Bean.@Component.@Controller.@Service.@Repository等. 这篇介绍另外一种给容器添加组件的方法:@Import注解,给容器中导入组件. @Import 导入组件 用法 @Import的用法

  • springboot swagger2注解使用的教程

    swagger2 注解整体说明  最近在使用Swagger的时候忘记了注解的用法,特此记录一下. @Api:用在请求的类上,表示对类的说明 tags="说明该类的作用,可以在UI界面上看到的注解" value="该参数没什么意义,在UI界面上也看到,所以不需要配置" @ApiOperation:用在请求的方法上,说明方法的用途.作用 value="说明方法的用途.作用" notes="方法的备注说明" @ApiImplicit

  • 使用@ApiModel遇到的问题及解决

    目录 @ApiModel遇到的问题 1. 习惯 2. 遇坑 3. 排查 4. 解决 @ApiModel和@ApiModelProperty 版本 @ApiModel @ApiModelProperty @ApiModel遇到的问题 使用 swagger2 中的 @ApiModel 注解不规范遇到的 swagger 文档 错乱问题: 1. 习惯 以前使用 swagger2 时, 在出入参实体上添加注解 @ApiModel 时习惯性的添加 value = "XXX" 属性, 旧版本中一直没

  • 全网最全SpringBoot集成swagger的详细教程

    全网最全SpringBoot集成swagger的详细教程

    目录 一. 接口文档概述 二. SpringBoot集成swagger2 2.1 引入依赖 2.2 引入配置 2.3 给Controller 添加注解 2.4 [404]问题解决 2.5 替换UI 三. SpringBoot集成swagger3 四. swaggerUI 拦截器和跨域冲突处理 五. 写在最后 一. 接口文档概述 swagger是当下比较流行的实时接口文文档生成工具.接口文档是当前前后端分离项目中必不可少的工具,在前后端开发之前,后端要先出接口文档,前端根据接口文档来进行项目的开发

  • springboot + swagger 实例代码

    springboot + swagger 实例代码

    swagger用于定义API文档. 好处: 前后端分离开发 API文档非常明确 测试的时候不需要再使用URL输入浏览器的方式来访问Controller 传统的输入URL的测试方式对于post请求的传参比较麻烦(当然,可以使用postman这样的浏览器插件) spring-boot与swagger的集成简单的一逼 1.项目结构 和上一节一样,没有改变. 2.pom.xml 引入了两个jar. <dependency> <groupId>io.springfox</groupId

随机推荐