關(guān)于@ApiModel和@ApiModelProperty的使用
更新時(shí)間：2023年11月20日 16:29:54 作者：Zz_糖小七
這篇文章主要介紹了關(guān)于@ApiModel和@ApiModelProperty的使用方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教
版本
- springfox-swagger2 (version = 2.9.2)
- swagger-bootstrap-ui (version = 1.9.6)
- swagger-models (version =1.6.1)
@ApiModel
使用場(chǎng)景
在實(shí)體類上邊使用，標(biāo)記類時(shí)swagger的解析類
| 屬性名稱 | 數(shù)據(jù)類型 | 默認(rèn)值 | 說明 |
|---|---|---|---|
| value | String | 類名 | 為模型提供備用名稱 |
| description | String | " | 提供詳細(xì)的類描述 |
| parent | Class<?> | Void.class | 為模型提供父類以允許描述繼承關(guān)系 |
| discriminator | String | " | 支持模型繼承和多態(tài)，使用鑒別器的字段的名稱，可以斷言需要使用哪個(gè)子類型 |
| subTypes | Class<?>[] | {} | 從此模型繼承的子類型數(shù)組 |
| reference | String | ‘’ | 指定對(duì)應(yīng)類型定義和引用，覆蓋指定的任何其它元數(shù)據(jù) |
@ApiModelProperty
使用場(chǎng)景
使用在被 @ApiModel 注解的模型類的屬性上
| 屬性名稱 | 數(shù)據(jù)類型 | 默認(rèn)值 | 說明 |
|---|---|---|---|
| value | String | " | 屬性簡(jiǎn)要說明 |
| name | String | " | 運(yùn)行覆蓋屬性的名稱，重寫屬性名稱 |
| 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 | " | 指定對(duì)應(yīng)類型定義的引用，覆蓋指定的任何其他元數(shù)據(jù) |
| allowEmptyValue | boolean | false | 允許傳空置，false：不允許傳空值 |
總結(jié)
以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。
相關(guān)文章
設(shè)計(jì)模式之構(gòu)建(Builder)模式 建造房子實(shí)例分析
構(gòu)建模式主要用來針對(duì)復(fù)雜產(chǎn)品生產(chǎn)，分離部件構(gòu)建細(xì)節(jié)，以達(dá)到良好的伸縮性,考慮到設(shè)計(jì)模式來源于建筑學(xué),因此舉一個(gè)建造房子的例子,需要的朋友可以參考下2012-12-12
淺談Java高并發(fā)解決方案以及高負(fù)載優(yōu)化方法
這篇文章主要介紹了淺談Java高并發(fā)解決方案以及高負(fù)載優(yōu)化方法，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2021-08-08
使用Java將一個(gè)List運(yùn)用遞歸轉(zhuǎn)成樹形結(jié)構(gòu)案例
這篇文章主要介紹了使用Java將一個(gè)List運(yùn)用遞歸轉(zhuǎn)成樹形結(jié)構(gòu)案例,本文通過詳細(xì)的案例來解釋說明了如何去操作,需要的朋友可以參考下2021-06-06
下面小編就為大家?guī)硪黄贚istener監(jiān)聽器生命周期(詳解)。小編覺得挺不錯(cuò)的，現(xiàn)在就分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧2017-10-10
Springboot接口項(xiàng)目如何使用AOP記錄日志
這篇文章主要介紹了Springboot接口項(xiàng)目如何使用AOP記錄日志,文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-06-06
Java將日期類型Date時(shí)間戳轉(zhuǎn)換為MongoDB的時(shí)間類型數(shù)據(jù)
今天小編就為大家分享一篇關(guān)于Java將日期類型Date時(shí)間戳轉(zhuǎn)換為MongoDB的時(shí)間類型數(shù)據(jù)，小編覺得內(nèi)容挺不錯(cuò)的，現(xiàn)在分享給大家，具有很好的參考價(jià)值，需要的朋友一起跟隨小編來看看吧2018-10-10
Spring?IOC容器Bean管理的完全注解開發(fā)放棄配置文件
這篇文章主要為大家介紹了Spring?IOC容器的Bean管理完全注解開發(fā)放棄配置文件，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪2022-05-05
這篇文章主要介紹了Java8 Stream flatmap中間操作用法解析,文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-07-07
本文介紹了Spring框架中的立即加載和延遲加載策略，并解釋了它們的適用場(chǎng)景和使用方法，根據(jù)具體的需求和應(yīng)用場(chǎng)景，選擇合適的加載策略，可以提高應(yīng)用程序的性能和資源利用效率，感興趣的朋友跟隨小編一起看看吧2023-07-07
Java 實(shí)戰(zhàn)項(xiàng)目之在線點(diǎn)餐系統(tǒng)的實(shí)現(xiàn)流程
讀萬(wàn)卷書不如行萬(wàn)里路，只學(xué)書上的理論是遠(yuǎn)遠(yuǎn)不夠的，只有在實(shí)戰(zhàn)中才能獲得能力的提升，本篇文章手把手帶你用java+SSM+jsp+mysql+maven實(shí)現(xiàn)一個(gè)在線點(diǎn)餐系統(tǒng),大家可以在過程中查缺補(bǔ)漏，提升水平2021-11-11