@ApiModel
使用場景
在實體類上邊使用，標記類時swagger的解析類
概述
提供有關swagger模型的其它信息，類將在操作中用作類型時自動內省
屬性
| 屬性名稱 | 數據類型 | 默認值 | 說明 |
|---|---|---|---|
| value | String | 類名 | 為模型提供備用名稱 |
| description | String | “” | 提供詳細的類描述 |
| parent | Class<?> parent | Void.class | 為模型提供父類以允許描述繼承關系 |
| discriminatory | String | “” | 支持模型繼承和多態，使用鑒別器的字段的名稱，可以斷言需要使用哪個子類型 |
| subTypes | Class<?>[] | {} | 從此模型繼承的子類型數組 |
| reference | String | “” | 指定對應類型定義的引用，覆蓋指定的任何其他元數據 |
@ApiModelProperty
使用場景
使用在被 @ApiModel 注解的模型類的屬性上
概述
添加和操作模型屬性的數據
屬性
| 屬性名稱 | 數據類型 | 默認值 | 說明 |
|---|---|---|---|
| value | String | “” | 屬性簡要說明 |
| name | String | “” | 運行覆蓋屬性的名稱。重寫屬性名稱 |
| allowableValues | String | “” | 限制參數可接收的值，三種方法，固定取值，固定范圍 |
| access | String | “” | 過濾屬性，參閱:io.swagger.core.filter.SwaggerSpecFilter |
| notes | String | “” | 目前尚未使用 |
| dataType | String | “” | 參數的數據類型，可以是類名或原始數據類型，此值將覆蓋從類屬性讀取的數據類型 |
| required | boolean | false | 是否為必傳參數,false:非必傳參數; true:必傳參數 |
| position | int | 0 | 允許在模型中顯示排序屬性 |
| hidden | boolean | false | 隱藏模型屬性，false:不隱藏; true:隱藏 |
| example | String | “” | 屬性的示例值 |
| readOnly | boolean | false | 指定模型屬性為只讀，false:非只讀; true:只讀 |
| reference | String | “” | 指定對應類型定義的引用，覆蓋指定的任何其他元數據 |
| allowEmptyValue | boolean | false | 允許傳空值，false:不允許傳空值; true:允許傳空值 |