Swagger注解-@ApiModel和@ApiModelProperty的用法
@ApiModel
使用場景
在實體類上邊使用,標(biāo)記類時swagger的解析類
概述
提供有關(guān)swagger模型的其它信息,類將在操作中用作類型時自動內(nèi)省
屬性
屬性名稱 | 數(shù)據(jù)類型 | 默認值 | 說明 |
---|---|---|---|
value | String | 類名 | 為模型提供備用名稱 |
description | String | “” | 提供詳細的類描述 |
parent | Class<?> parent | Void.class | 為模型提供父類以允許描述繼承關(guān)系 |
discriminatory | String | “” | 支持模型繼承和多態(tài),使用鑒別器的字段的名稱,可以斷言需要使用哪個子類型 |
subTypes | Class<?>[] | {} | 從此模型繼承的子類型數(shù)組 |
reference | String | “” | 指定對應(yīng)類型定義的引用,覆蓋指定的任何其他元數(shù)據(jù) |
@ApiModelProperty
使用場景
使用在被 @ApiModel 注解的模型類的屬性上
概述
添加和操作模型屬性的數(shù)據(jù)
屬性
屬性名稱 | 數(shù)據(jù)類型 | 默認值 | 說明 |
---|---|---|---|
value | String | “” | 屬性簡要說明 |
name | String | “” | 運行覆蓋屬性的名稱。重寫屬性名稱 |
allowableValues | String | “” | 限制參數(shù)可接收的值,三種方法,固定取值,固定范圍 |
access | String | “” | 過濾屬性,參閱: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 | “” | 指定對應(yīng)類型定義的引用,覆蓋指定的任何其他元數(shù)據(jù) |
allowEmptyValue | boolean | false | 允許傳空值,false:不允許傳空值; true:允許傳空值 |
Swagger踩坑@ApiModel注解問題
@ApiModel內(nèi)的注釋 不要出現(xiàn)相同 否則會將相同的vo內(nèi)的字段進行合并
補充:
@ApiModel(description = "碼農(nóng)") description內(nèi)的值 不要相同就可以避免
例如改為:@ApiModel(description = "碼農(nóng)2")
以上為個人經(jīng)驗,希望能給大家一個參考,也希望大家多多支持腳本之家。
相關(guān)文章
SpringBoot實戰(zhàn)記錄之?dāng)?shù)據(jù)訪問
對于數(shù)據(jù)訪問層,無論是SQL還是NOSQL,Spring Boot默認采用整合Spring Data的方式進行統(tǒng)一處理,添加大量自動配置,屏蔽了很多設(shè)置,下面這篇文章主要介紹了SpringBoot實戰(zhàn)記錄之?dāng)?shù)據(jù)訪問,需要的朋友可以參考下2022-04-04java面試JDK8?new?ReentrantLock()加鎖流程解析
這篇文章主要為大家介紹了java面試JDK8?new?ReentrantLock()加鎖流程解析,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2023-07-07