Swagger注解-@ApiModel和@ApiModelProperty的用法
更新時(shí)間：2022年06月14日 10:49:36 作者：時(shí)間會(huì)告訴你答案，但不能重來(lái)
這篇文章主要介紹了Swagger注解-@ApiModel和@ApiModelProperty的用法，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教
@ApiModel
使用場(chǎng)景
在實(shí)體類上邊使用，標(biāo)記類時(shí)swagger的解析類
概述
提供有關(guān)swagger模型的其它信息，類將在操作中用作類型時(shí)自動(dòng)內(nèi)省
屬性
| 屬性名稱 | 數(shù)據(jù)類型 | 默認(rèn)值 | 說(shuō)明 |
|---|---|---|---|
| value | String | 類名 | 為模型提供備用名稱 |
| description | String | “” | 提供詳細(xì)的類描述 |
| parent | Class<?> parent | Void.class | 為模型提供父類以允許描述繼承關(guān)系 |
| discriminatory | String | “” | 支持模型繼承和多態(tài)，使用鑒別器的字段的名稱，可以斷言需要使用哪個(gè)子類型 |
| subTypes | Class<?>[] | {} | 從此模型繼承的子類型數(shù)組 |
| reference | String | “” | 指定對(duì)應(yīng)類型定義的引用，覆蓋指定的任何其他元數(shù)據(jù) |
@ApiModelProperty
使用場(chǎng)景
使用在被 @ApiModel 注解的模型類的屬性上
概述
添加和操作模型屬性的數(shù)據(jù)
屬性
| 屬性名稱 | 數(shù)據(jù)類型 | 默認(rèn)值 | 說(shuō)明 |
|---|---|---|---|
| value | String | “” | 屬性簡(jiǎn)要說(shuō)明 |
| name | String | “” | 運(yùn)行覆蓋屬性的名稱。重寫屬性名稱 |
| allowableValues | String | “” | 限制參數(shù)可接收的值，三種方法，固定取值，固定范圍 |
| access | String | “” | 過(guò)濾屬性，參閱:io.swagger.core.filter.SwaggerSpecFilter |
| notes | String | “” | 目前尚未使用 |
| dataType | String | “” | 參數(shù)的數(shù)據(jù)類型，可以是類名或原始數(shù)據(jù)類型，此值將覆蓋從類屬性讀取的數(shù)據(jù)類型 |
| 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)類型定義的引用，覆蓋指定的任何其他元數(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)文章
mybatis-plus的IService接口默認(rèn)提供saveBatch批量插入，也是唯一一個(gè)默認(rèn)批量插入，在數(shù)據(jù)量不是很大的情況下可以直接使用，本文帶你詳細(xì)了解MyBatis-plus 批量插入的通用方法及使用方法，需要的朋友可以參考一下2023-04-04
spring cloud整合ribbon問(wèn)題及解決方案
很多小伙伴在整合ribbon都出了相同的問(wèn)題,今天特地為大家整理了該問(wèn)題的解決方案,文中有非常詳細(xì)的圖文解說(shuō),對(duì)出現(xiàn)同樣問(wèn)題的小伙伴們很有幫助,需要的朋友可以參考下2021-05-05
SpringBoot實(shí)戰(zhàn)記錄之?dāng)?shù)據(jù)訪問(wèn)
對(duì)于數(shù)據(jù)訪問(wèn)層,無(wú)論是SQL還是NOSQL,Spring Boot默認(rèn)采用整合Spring Data的方式進(jìn)行統(tǒng)一處理,添加大量自動(dòng)配置,屏蔽了很多設(shè)置,下面這篇文章主要介紹了SpringBoot實(shí)戰(zhàn)記錄之?dāng)?shù)據(jù)訪問(wèn),需要的朋友可以參考下2022-04-04
Java基于IO流實(shí)現(xiàn)登錄和注冊(cè)功能
這篇文章主要為大家詳細(xì)介紹了Java基于IO流實(shí)現(xiàn)登錄和注冊(cè)功能，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2022-04-04
這篇文章主要介紹了idea中如何使用(Undo Commit...)問(wèn)題，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2023-02-02
java面試JDK8?new?ReentrantLock()加鎖流程解析
這篇文章主要為大家介紹了java面試JDK8?new?ReentrantLock()加鎖流程解析，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2023-07-07
數(shù)組是用來(lái)存儲(chǔ)一系列數(shù)據(jù)，但它往往被認(rèn)為是一系列相同類型的變量，異常是程序中的一些錯(cuò)誤，但并不是所有的錯(cuò)誤都是異常，并且錯(cuò)誤有時(shí)候是可以避免的，接下來(lái)讓我們?cè)敿?xì)的了解吧2022-03-03
詳解Spring不同數(shù)據(jù)庫(kù)異常如何抽象的
根據(jù)spring-jdbc中的定義,所有的數(shù)據(jù)操作異常都會(huì)轉(zhuǎn)換為 DataAccessException,下面這篇文章主要給大家介紹了關(guān)于Spring不同數(shù)據(jù)庫(kù)異常如何抽象的相關(guān)資料,需要的朋友可以參考下2021-09-09
這篇文章主要介紹了Spring Boot打包部署和環(huán)境配置詳解，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2019-05-05
這篇文章主要介紹了java高質(zhì)量縮放圖片的示例代碼，幫助大家更好的使用Java處理圖片，感興趣的朋友可以了解下2020-09-09