Swagger 註解說明
阿新 • • 發佈:2018-11-20
1 @Api() 用於類;表示標識這個類是swagger的資源 2 tags–表示說明 3 value–也是說明,可以使用tags替代 4 5 @ApiOperation() 用於方法;表示一個http請求的操作 6 value用於方法描述 7 notes用於提示內容 8 9 10 @ApiParam() 用於方法,引數,欄位說明;表示對引數的新增元資料(說明或是否必填等) 11 name–引數名 12 value–引數說明 13 required–是否必填 14 15 @ApiModel()用於類 ;表示對類進行說明,用於引數用實體類接收 16 value–表示物件名 17 18 @ApiModelProperty()用於方法,欄位; 表示對model屬性的說明或者資料操作更改 19 value–欄位說明 20 name–重寫屬性名字 21 dataType–重寫屬性型別 22 required–是否必填 23 example–舉例說明 24 hidden–隱藏 25 26 @ApiImplicitParam() 用於方法 27 表示單獨的請求引數 28 29 @ApiImplicitParams() 用於方法,包含多個 @ApiImplicitParam 30 name–引數ming 31 value–引數說明 32 dataType–資料型別 33 paramType–引數型別 34 example–舉例說明 35 36 @ApiIgnore 37 作用於方法上,使用這個註解swagger將忽略這個介面