Swagger注解-@ApiModel 和 @ApiModelProperty

全栈程序员-站长 • 2022年4月8日上午7:20 • 未分类 • 阅读 201

@ApiModel使用场景在实体类上边使用，标记类时swagger的解析类概述提供有关swagger模型的其它信息，类将在操作中用作类型时自动内省属性属性名称数据类型默认值说明valueString类名为模型提供备用名称descriptionString“”提供详细的类描述parentClass<?>parentVoid…

大家好，又见面了，我是你们的朋友全栈君。

Swagger注解-@Api
Swagger注解-@ApiOperation
Swagger注解-@ApiImplicitParams 和 @ApiImplicitParam
Swagger注解-@ApiModel 和 @ApiModelProperty
Swagger注解-@ApiResponses 和 @ApiResponse
Swagger注解-@ResponseHeader
Swagger注解-@ApiParam
Swagger注解-@Authorization 和 @AuthorizationScope
Swagger注解-@SwaggerDefinition
Swagger注解-@ExternalDocs
Springboot 集成 Swagger GitHub 地址

@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注解-@Api
Swagger注解-@ApiOperation
Swagger注解-@ApiImplicitParams 和 @ApiImplicitParam
Swagger注解-@ApiModel 和 @ApiModelProperty
Swagger注解-@ApiResponses 和 @ApiResponse
Swagger注解-@ResponseHeader
Swagger注解-@ApiParam
Swagger注解-@Authorization 和 @AuthorizationScope
Swagger注解-@SwaggerDefinition
Swagger注解-@ExternalDocs
Springboot 集成 Swagger GitHub 地址

版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容，请发送邮件至举报，一经查实，本站将立刻删除。

发布者：全栈程序员-站长，转载请注明出处：https://javaforall.net/126651.html原文链接：https://javaforall.net

赞 (0)

全栈程序员-站长

0 0

TransactionScope Troubleshooting[通俗易懂]

TransactionScope Troubleshooting[通俗易懂]只要涉及到数据库的操作，那么使用事务就是难免的。如果我们使用LINQtoSQL作为数据访问层，那么LINQ提供的SubmitChanges()方法自身就包含了对事务的处理。当然，我们也可以利用System.Data.Common.DbTransaction对事务进行处理，我们可以调用DataContext中Connection的方法BeginTransaction()启动事务，然后根据情况进行

全栈程序员-站长
2022年7月19日
linux获取root权限命令_linux最高权限获取命令

linux获取root权限命令_linux最高权限获取命令Linux上一切皆文件,不管什么程序,读取文件就能获取一个UUID.Linux内核提供有UUID生成接口:cat/proc/sys/kernel/random/uuid　　获取系统uuiddmidecode-ssystem-uuid|tr’A-Z”a-z’　　转载于:https://www.cnblogs.com/navysummer/…

全栈程序员-站长
2022年8月10日
mac sh文件_android获取apk位置

mac sh文件_android获取apk位置在嵌入百度地图SDK的时候需要配置“发布版SHA1”和“开发版SHA1”，这两个是不一样的。这里是基于mac电脑，开发工具androidstudio.1、首先打开Terminal窗口，会直接定位到当前的目录下。2、获取开发版的sha1,直接输入命令，获取到sha1：keytool-list-v-keystore~/.android/debug…

全栈程序员-站长
2022年8月10日
网络综合布线工程后期验收

网络综合布线工程后期验收

全栈程序员-站长
2021年8月7日
unity 3D_unitywebrequest

unity 3D_unitywebrequest感觉Restsharp和unity3D提供的WWW有很多相似的地方，但是unity3D的WWW分装了跟多的东西，比如TextureMovieTexture等等：互联网上关于.NET（C#）的HTTP相关的辅助类还是比较多的，这里再为大家推荐一个.NET的HTTP辅助类，它叫RestSharp。RestSharp是一个轻量的，不依赖任何第三方的组件或者类库的H

全栈程序员-站长
2022年9月8日
Eclipse中安装&使用SVN

Eclipse中安装&使用SVNEclipse中安装&使用SVN

全栈程序员-站长
2022年4月24日

发表回复

关注全栈程序员社区公众号