Swagger注解

swagger2注解中的全參數(shù)

@Api?

Api 標記可以標記一個Controller類做為swagger 文檔資源,使用方式

@ApiOperation每一個url資源的定義,使用方式

@ApiParam標記參數(shù)

@ApiImplicitParams:用在請求的方法上,包含一組參數(shù)說明

@ApiImplicitParam對容器的描述

@ApiResponse用于請求的方法上,表示一組響應

@ApiModel()用于類 ;表示對類進行說明,用于參數(shù)用實體類接收

? ? ? ? ? ? ? ? ? ? ? value–表示對象名

? ? ? ? ? ? ? ? ? ? ? description–描述

? ? ? ? ? ? ? ? ? ? ? ?都可省略

@ApiModelProperty()用于方法,字段; 表示對model屬性的說明或者數(shù)據(jù)操作更改

? ? ? ? ? ? ? ? ? ? ? value–字段說明

? ? ? ? ? ? ? ? ? ? ? name–重寫屬性名字

? ? ? ? ? ? ? ? ? ? ? dataType–重寫屬性類型

? ? ? ? ? ? ? ? ? ? ? required–是否必填

? ? ? ? ? ? ? ? ? ? ? example–舉例說明

? ? ? ? ? ? ? ? ? ? ? hidden–隱藏

? ? ? ? ? ? ? ? ? ? ? 都可省略

更詳細請看鏈接:swagger注解

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
【社區(qū)內容提示】社區(qū)部分內容疑似由AI輔助生成,瀏覽時請結合常識與多方信息審慎甄別。
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發(fā)布,文章內容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。

相關閱讀更多精彩內容

友情鏈接更多精彩內容