原文地址:https://blog.csdn.net/xiaojin21cen/article/details/78654652
1.@Api:用在請求的類上,表示對類的說明 tags="說明該類的作用,可以在UI界面上看到的註解" value="該參數沒什麼意義,在UI界面上也看到,所以不需要配置" 2.@ApiOperation:用在請求的方法上,說明方法的用途、作用 value="說明方法的用途、作用" notes="方法的備註說明" 3.@ApiImplicitParams:用在請求的方法上,表示一組參數說明 3.1@ApiImplicitParam:用在@ApiImplicitParams註解中,指定一個請求參數的各個方面 name:參數名 value:參數的漢字說明、解釋 required:參數是否必須傳 paramType:參數放在哪個地方 · header --> 請求參數的獲取:@RequestHeader · query --> 請求參數的獲取:@RequestParam · path(用於restful接口)--> 請求參數的獲取:@PathVariable · body(不常用) · form(不常用) dataType:參數類型,默認String,其它值dataType="int",顯示時會顯示爲Integer,直接填Integer會顯示ref defaultValue:參數的默認值 4.@ApiResponses:用在請求的方法上,表示一組響應 4.1@ApiResponse:用在@ApiResponses中,一般用於表達一個錯誤的響應信息 code:數字,例如400 message:信息,例如"請求參數沒填好" response:拋出異常的類 5.@ApiModel:用於響應類上,表示一個返回響應數據的信息 (這種一般用在post創建的時候,使用@RequestBody這樣的場景, 請求參數無法使用@ApiImplicitParam註解進行描述的時候) @ApiModelProperty:用在屬性上,描述響應類的屬性