Swagger注解-@ApiParam
使用場景
在 Rest 接口上或 Rest 接口參數前邊使用。
概述
為 Rest 接口參數添加其它元數據(導入到 yapi 中不會被解析)。
屬性
屬性名稱 數據類型 默認值 說明
name String “” 參數名稱，參數名稱將從 filed/method/parameter 名稱中派生，但你可以覆蓋它，路徑參數必須始終命名為它們所代表的路徑部分
value String “” 參數簡單描述
defaultValue String “” 描述參數默認值
allowableValues String “” 可接收參數值限制，有三種方式,取值列表，取值范圍
required boolean false 是否為必傳參數, false:非必傳; true:必傳
access String “” 參數過濾，請參閱:io.swagger.core.filter.SwaggerSpecFilter
allowMultiple boolean false 指定參數是否可以通過多次出現來接收多個值
hidden boolean false 隱藏參數列表中的參數
example String “” 非請求體(body)類型的單個參數示例
examples Example @Example(value = @ExampleProperty(mediaType = “”, value = “”)) 參數示例，僅適用於請求體類型的請求
type String “” 添加覆蓋檢測到類型的功能
format String “” 添加提供自定義format格式的功能
allowEmptyValue boolean false 添加將格式設置為空的功能
readOnly boolean false 添加被指定為只讀的能力
collectionFormat String “” 添加使用 array 類型覆蓋 collectionFormat 的功能
========================== 上面方便copy ===============================
