關(guān)于@ApiModel和@ApiModelProperty的使用
更新時間：2023年11月20日 16:29:54 作者：Zz_糖小七
這篇文章主要介紹了關(guān)于@ApiModel和@ApiModelProperty的使用方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教
版本
- springfox-swagger2 (version = 2.9.2)
- swagger-bootstrap-ui (version = 1.9.6)
- swagger-models (version =1.6.1)
@ApiModel
使用場景
在實體類上邊使用，標記類時swagger的解析類
| 屬性名稱 | 數(shù)據(jù)類型 | 默認值 | 說明 |
|---|---|---|---|
| value | String | 類名 | 為模型提供備用名稱 |
| description | String | " | 提供詳細的類描述 |
| parent | Class<?> | Void.class | 為模型提供父類以允許描述繼承關(guān)系 |
| discriminator | String | " | 支持模型繼承和多態(tài)，使用鑒別器的字段的名稱，可以斷言需要使用哪個子類型 |
| subTypes | Class<?>[] | {} | 從此模型繼承的子類型數(shù)組 |
| reference | String | ‘’ | 指定對應(yīng)類型定義和引用，覆蓋指定的任何其它元數(shù)據(jù) |
@ApiModelProperty
使用場景
使用在被 @ApiModel 注解的模型類的屬性上
| 屬性名稱 | 數(shù)據(jù)類型 | 默認值 | 說明 |
|---|---|---|---|
| value | String | " | 屬性簡要說明 |
| name | String | " | 運行覆蓋屬性的名稱，重寫屬性名稱 |
| allowableValues | String | " | 限制參數(shù)可接受的值 |
| access | String | " | 過濾屬性 |
| notes | String | " | 尚未使用 |
| dataType | String | " | 參數(shù)的數(shù)據(jù)類型 |
| required | boolean | false | 是否必傳 |
| position | int | 0 | 允許在模型中排序?qū)傩?/td> |
| hidden | boolean | false | 隱藏模型屬性 |
| example | String | " | 屬性的示例值 |
| readOnly | boolean | false | 指定模型屬性為只讀，false:非只讀 |
| reference | String | " | 指定對應(yīng)類型定義的引用，覆蓋指定的任何其他元數(shù)據(jù) |
| allowEmptyValue | boolean | false | 允許傳空置，false：不允許傳空值 |
總結(jié)
以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關(guān)文章
這篇文章主要介紹了MyBatis根據(jù)條件批量修改字段的方式，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2023-02-02
Java 8 Stream Api 中的 map和 flatMap 操作方法
Java 8提供了非常好用的 Stream API ,可以很方便的操作集合。今天通過這篇文章給大家分享Java 8 Stream Api 中的 map和 flatMap 操作方法,需要的朋友可以參考下2019-11-11
這篇文章主要介紹了mybatis test標簽判斷值是否相等的操作，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-07-07
SpringBoot中@Configuration和@Bean和@Component相同點詳解
這篇文章主要介紹了SpringBoot中@Configuration和@Bean和@Component相同點詳解,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2025-04-04
如何使用Code128字體將文本轉(zhuǎn)換為code128條形碼
這篇文章主要介紹了如何使用Code128字體將文本轉(zhuǎn)換為code128條形碼 ,非常不錯，具有一定的參考借鑒價值，需要的朋友可以參考下2019-04-04
JAVA 實現(xiàn)二叉樹（鏈式存儲結(jié)構(gòu)）
本篇文章主要介紹用JAVA 實現(xiàn)二叉樹,并提供實例.對二叉樹數(shù)據(jù)結(jié)構(gòu)很好的學習實踐,有需要的朋友可以參考下2016-07-07
今天給大家總結(jié)一下SpringBoot下攔截器的使用，需要的朋友參考下吧2017-05-05
出于安全考慮,我們需要后端返回的圖片只允許在某個網(wǎng)站內(nèi)展示,不想被爬蟲拿到圖片地址后被下載,或者,不想瀏覽器直接訪問圖片鏈接,所以本文將給大家介紹SpringBoot實現(xiàn)圖片防盜鏈功能,需要的朋友可以參考下2024-04-04
關(guān)于@JSONField和@JsonFormat的使用區(qū)別說明
這篇文章主要介紹了關(guān)于@JSONField 和 @JsonFormat的區(qū)別說明，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-11-11
這篇文章主要介紹了Java響應(yīng)式編程之handle用法解析，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-10-10