Swagger注解-@ApiModel和@ApiModelProperty的用法
更新時(shí)間：2022年06月14日 10:49:36 作者：時(shí)間會(huì)告訴你答案，但不能重來(lái)
這篇文章主要介紹了Swagger注解-@ApiModel和@ApiModelProperty的用法，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教
@ApiModel
使用場(chǎng)景
在實(shí)體類(lèi)上邊使用，標(biāo)記類(lèi)時(shí)swagger的解析類(lèi)
概述
提供有關(guān)swagger模型的其它信息，類(lèi)將在操作中用作類(lèi)型時(shí)自動(dòng)內(nèi)省
屬性
| 屬性名稱(chēng) | 數(shù)據(jù)類(lèi)型 | 默認(rèn)值 | 說(shuō)明 |
|---|---|---|---|
| value | String | 類(lèi)名 | 為模型提供備用名稱(chēng) |
| description | String | “” | 提供詳細(xì)的類(lèi)描述 |
| parent | Class<?> parent | Void.class | 為模型提供父類(lèi)以允許描述繼承關(guān)系 |
| discriminatory | String | “” | 支持模型繼承和多態(tài)，使用鑒別器的字段的名稱(chēng)，可以斷言需要使用哪個(gè)子類(lèi)型 |
| subTypes | Class<?>[] | {} | 從此模型繼承的子類(lèi)型數(shù)組 |
| reference | String | “” | 指定對(duì)應(yīng)類(lèi)型定義的引用，覆蓋指定的任何其他元數(shù)據(jù) |
@ApiModelProperty
使用場(chǎng)景
使用在被 @ApiModel 注解的模型類(lèi)的屬性上
概述
添加和操作模型屬性的數(shù)據(jù)
屬性
| 屬性名稱(chēng) | 數(shù)據(jù)類(lèi)型 | 默認(rèn)值 | 說(shuō)明 |
|---|---|---|---|
| value | String | “” | 屬性簡(jiǎn)要說(shuō)明 |
| name | String | “” | 運(yùn)行覆蓋屬性的名稱(chēng)。重寫(xiě)屬性名稱(chēng) |
| allowableValues | String | “” | 限制參數(shù)可接收的值，三種方法，固定取值，固定范圍 |
| access | String | “” | 過(guò)濾屬性，參閱:io.swagger.core.filter.SwaggerSpecFilter |
| notes | String | “” | 目前尚未使用 |
| dataType | String | “” | 參數(shù)的數(shù)據(jù)類(lèi)型，可以是類(lèi)名或原始數(shù)據(jù)類(lèi)型，此值將覆蓋從類(lèi)屬性讀取的數(shù)據(jù)類(lèi)型 |
| required | boolean | false | 是否為必傳參數(shù),false:非必傳參數(shù); true:必傳參數(shù) |
| position | int | 0 | 允許在模型中顯示排序?qū)傩?/td> |
| hidden | boolean | false | 隱藏模型屬性，false:不隱藏; true:隱藏 |
| example | String | “” | 屬性的示例值 |
| readOnly | boolean | false | 指定模型屬性為只讀，false:非只讀; true:只讀 |
| reference | String | “” | 指定對(duì)應(yīng)類(lèi)型定義的引用，覆蓋指定的任何其他元數(shù)據(jù) |
| allowEmptyValue | boolean | false | 允許傳空值，false:不允許傳空值; true:允許傳空值 |
Swagger踩坑@ApiModel注解問(wèn)題
@ApiModel內(nèi)的注釋 不要出現(xiàn)相同 否則會(huì)將相同的vo內(nèi)的字段進(jìn)行合并
補(bǔ)充：
@ApiModel(description = "碼農(nóng)") description內(nèi)的值 不要相同就可以避免
例如改為：@ApiModel(description = "碼農(nóng)2")
以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。
相關(guān)文章
Java調(diào)用groovy實(shí)現(xiàn)原理代碼實(shí)例
這篇文章主要介紹了Java調(diào)用groovy實(shí)現(xiàn)原理代碼實(shí)例,文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-12-12
Java字符串轉(zhuǎn)換為Date對(duì)象,通常需要使用SimpleDateFormat類(lèi),該類(lèi)提供了日期格式化和解析的方法,但需要注意日期格式模式的選擇、異常處理和線程安全性2025-02-02
JAVA通過(guò)HttpURLConnection 上傳和下載文件的方法
這篇文章主要介紹了JAVA通過(guò)HttpURLConnection 上傳和下載文件的方法，非常具有實(shí)用價(jià)值，需要的朋友可以參考下2017-09-09
SpringBoot使用JavaCV處理rtsp流的示例代碼
這篇文章主要為大家詳細(xì)介紹了SpringBoot使用JavaCV處理rtsp流,文中的示例代碼講解詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴可以跟隨小編一起了解一下2024-02-02
Java鏈表中元素刪除的實(shí)現(xiàn)方法詳解【只刪除一個(gè)元素情況】
這篇文章主要介紹了Java鏈表中元素刪除的實(shí)現(xiàn)方法,結(jié)合實(shí)例形式分析了java只刪除鏈表中一個(gè)元素的相關(guān)操作原理、實(shí)現(xiàn)方法與注意事項(xiàng),需要的朋友可以參考下2020-03-03
在java中判斷兩個(gè)浮點(diǎn)型(float)數(shù)據(jù)是否相等的案例
這篇文章主要介紹了在java中判斷兩個(gè)浮點(diǎn)型(float)數(shù)據(jù)是否相等的案例，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2020-10-10
這篇文章主要介紹了Java8新特性:lambda表達(dá)式總結(jié),本文總結(jié)了多種語(yǔ)法格式和使用方法,包含了函數(shù)式接口和內(nèi)置的四大核心函數(shù)式接口的用法實(shí)例,需要的朋友可以參考下2021-06-06
java swing標(biāo)準(zhǔn)對(duì)話框具體實(shí)現(xiàn)
這篇文章介紹了swing標(biāo)準(zhǔn)對(duì)話框的具體實(shí)現(xiàn)方法，有需要的朋友可以參考一下2013-06-06
這篇文章主要介紹了使用spring?jpa?如何給外鍵賦值，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2022-06-06
java 生成有序賬號(hào)的實(shí)現(xiàn)方法
下面小編就為大家?guī)?lái)一篇java 生成有序賬號(hào)的實(shí)現(xiàn)方法。小編覺(jué)得挺不錯(cuò)的，現(xiàn)在就分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2016-10-10