swagger注解@ApiModelProperty失效情況的解決
swagger注解@ApiModelProperty失效
swagger 版本 2.29.2
解決方式: 小寫字段名
@ApiModelProperty注解的使用
首先要知道@ApiModelProperty是swagger的注解,它的作用是添加和操作屬性模塊的數(shù)據(jù)
下面是它內(nèi)部的常用屬性
1、value()
String value() default "";
參數(shù)類型為String,作用為此屬性的簡要描述。
2、name()
String name() default "";
參數(shù)類型為String,作用為允許重寫屬性的名稱。
3、allowableValues()
String allowableValues() default "";
參數(shù)類型為String,作用為限制此參數(shù)存儲的長度。
4、access()
String access() default "";
參數(shù)類型為String,作用為允許從API文檔中過濾屬性
5、notes()
String notes() default "";
參數(shù)類型為String,作用為該字段的注釋說明
6、dataType()
String dataType() default "";
參數(shù)類型為String,作用為參數(shù)的數(shù)據(jù)類型。
7、required()
boolean required() default false;
參數(shù)類型為String,作用為指定參數(shù)是否可以為空,默認(rèn)為false
8、 position()
int position() default 0;
參數(shù)類型為int,作用為允許顯式地對模型中的屬性排序。
9、hidden()
boolean hidden() default false;
參數(shù)類型為boolean,作用為是否允許模型屬性隱藏在Swagger模型定義中,默認(rèn)為false。
10、example()
String example() default "";
參數(shù)為String類型,作用為屬性的示例值。
11、readOnly()
boolean readOnly() default false;
參數(shù)類型為boolean,作用為是否允許將屬性指定為只讀,默認(rèn)為false。
12、reference()
String reference() default "";
參數(shù)類型為String,作用為指定對對應(yīng)類型定義的引用,重寫指定的任何其他數(shù)據(jù)名稱。
13、allowEmptyValue()
boolean allowEmptyValue() default false;
參數(shù)類型為boolean,作用為是否允許傳遞空值,默認(rèn)為false
示例:
? @ApiModelProperty(value = "主鍵",name = "id", ? ?? ? ?allowableValues = "32", ? ? ? access = "1", ? ? ? notes = "用戶的id", ? ? ? dataType = "int", ? ? ? required = false, ? ? ? position = 1, ? ? ? hidden = true, ? ? ? example = "1", ? ? ? readOnly = false, ? ? ? reference = "id", ? ? ? allowEmptyValue = false) ? @TableId(value = "id",type = IdType.AUTO) ? private int id;
以上為個(gè)人經(jīng)驗(yàn),希望能給大家一個(gè)參考,也希望大家多多支持腳本之家。
相關(guān)文章
關(guān)于spring中單例Bean引用原型Bean產(chǎn)生的問題及解決
這篇文章主要介紹了關(guān)于spring中單例Bean引用原型Bean產(chǎn)生的問題及解決方案,具有很好的參考價(jià)值,希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-06-06springboot如何獲取接口下所有實(shí)現(xiàn)類
這篇文章主要介紹了springboot如何獲取接口下所有實(shí)現(xiàn)類問題,具有很好的參考價(jià)值,希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-09-09SpringBoot項(xiàng)目啟動后立馬自動關(guān)閉的解決方案
這篇文章主要介紹了SpringBoot項(xiàng)目啟動后立馬自動關(guān)閉的解決方案,具有很好的參考價(jià)值,希望對大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-03-03SpringMVC的簡單傳值(實(shí)現(xiàn)代碼)
下面小編就為大家?guī)硪黄猄pringMVC的簡單傳值(實(shí)現(xiàn)代碼)。小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧2016-05-05