1. 程式人生 > >swagger常用註解

swagger常用註解

@ApiIgnore 忽略註解標註的類或者方法,不新增到API文件中 @ApiOperation 展示每個API基本資訊 value api名稱 notes 備註說明 @ApiImplicitParam 用於規定接收引數型別、名稱、是否必須等資訊 name 對應方法中接收引數名稱 value 備註說明 required 是否必須 boolean paramType 引數型別 body、path、query、header、form中的一種 body 使用@RequestBody接收資料 POST有效 path 在url中配置{id}的引數 query 普通查詢引數 例如 ?query=q ,jquery ajax中data設定的值也可以,例如 {query:”q”},springMVC中不需要添加註解接收 header 使用@RequestHeader接收資料 form 筆者未使用,請檢視官方API文件 dataType 資料型別,如果型別名稱相同,請指定全路徑,例如 dataType = “java.util.Date”,springfox會自動根據型別生成模型 @ApiImplicitParams 包含多個@ApiImplicitParam @ApiModelProperty 對模型中屬性新增說明,例如 上面的PageInfoBeen、BlogArticleBeen這兩個類中使用,只能使用在類中。 value 引數名稱 required 是否必須 boolean hidden 是否隱藏 boolean 其他資訊和上面同名屬性作用相同,hidden屬性對於集合不能隱藏,目前不知道原因 @ApiParam 對單獨某個引數進行說明,使用在類中或者controller方法中都可以。註解中的屬性和上面列出的同名屬性作用相同