swagger使用以及一些注解說明

@Api：作用於Conntroller類上 value：字段說明 description：描述 tags：分組 (經常用到tags，例如如下，我只是給value，則默認應用了類名)

 

@ApiOperation: value：接口用途（必選） 直接在注解后括號內寫，即value的值，會在swagger-ui里顯示，具體示例如下 notes：備注說明（可選） httpMethod：請求方式（可選） response：返回參數類型（可選） tags：接口分組名（可選）

 

 

@ApiImplicitParams:（可選，當描述多個@ApiImlicitParam時使用）,即描述多個參數的時候使用

   @ApiImplicitParam(

　　接口入參描述，本身可選，對應的子字段也可選。

　　name：參數屬性命

　　value：參數說明

　　required：是否必傳 true/false

　　paramType：請求參數的獲取方式

　　　　header：@RequestHeader 從請求頭獲取

　　　　query：@RequestParam 從請求參數獲取

　　　　path：@PathVariable 從請求的路徑獲取，這也是使用動態請求url的使用的注解

　　　　body:@RequestBody 使用此注解，可以選擇接收參數為對象類型

　　　　form：極少使用，請求表單中獲取

　　dataType：參數類型

　　defaultValue：參數默認值

)

@PathVariable的使用示例如下：

 

 

@ApiIgnore: 作用於接口入參參數列表，表示swagger忽略該入參

@ApiModelProperty:作用於入參實體對象的屬性上（本身可選，對應子字段也全部可選） value：字段描述 name：屬性名字 dataType：屬性類型 required：是否必傳 example：參數樣例 hidden：隱藏

@ApiResponses:(接口返回結果；可選，當描述多個@ApiResponse時候使用) @ApiResponse：（可選） code：HTTP請求返回碼。（必選） message：返回信息。（必選） response：返回類型，需使用全類名。eg："com.xxx.dto.DemoRequestDTO.class"（可選）