首先要知道@ApiModelProperty是swagger的注解,它的作用是添加和操作属性模块的数据
1、value()
参数类型为String,作用为此属性的简要描述。
2、name()
参数类型为String,作用为允许重写属性的名称。
3、allowableValues()
参数类型为String,作用为限制此参数存储的长度。
4、access()
参数类型为String,作用为允许从API文档中过滤属性
5、notes()
参数类型为String,作用为该字段的注释说明
6、dataType()
参数类型为String,作用为参数的数据类型。
7、required()
参数类型为String,作用为指定参数是否可以为空,默认为false
8、 position()
参数类型为int,作用为允许显式地对模型中的属性排序。
9、hidden()
参数类型为boolean,作用为是否允许模型属性隐藏在Swagger模型定义中,默认为false。
10、example()
参数为String类型,作用为属性的示例值。
11、readOnly()
参数类型为boolean,作用为是否允许将属性指定为只读,默认为false。
12、reference()
参数类型为String,作用为指定对对应类型定义的引用,重写指定的任何其他数据名称。
13、allowEmptyValue()
参数类型为boolean,作用为是否允许传递空值,默认为false
示例:
以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。
到此这篇swagger2注解无效(swagger注解使用)的文章就介绍到这了,更多相关内容请继续浏览下面的相关 推荐文章,希望大家都能在编程的领域有一番成就!版权声明:
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如若内容造成侵权、违法违规、事实不符,请将相关资料发送至xkadmin@xkablog.com进行投诉反馈,一经查实,立即处理!
转载请注明出处,原文链接:https://www.xkablog.com/rfx/36177.html