swagger常用註解
阿新 • • 發佈:2022-03-15
1. @Api()
作用於類,放置於controller的一個類上,標誌這個類是swagger資源
@Api(value = "說明", tags = "說明")
2. @ApiOperation()
作用方法上
@ApiOperation(value = "獲取當前使用者資訊", notes = "通過賬號、手機、郵箱查詢使用者資訊" )
3. @ApiParam()
作用於方法,用於引數欄位的說明
@ApiParam(name = "username", value = "值為 賬號、手機、郵箱", required = true)
4. @ApiModel()
用於類,對類進行說明
@ApiModel(value="使用者基本資訊" , description="使用者基本資訊。")
5. @ApiModelProperty()
用於實體類 欄位
@ApiModelProperty(value = "使用者序號", name = "gtUserId", required = true)
6. @ApiImplicitParams()
用於方法解釋請求引數裡邊新增@ApiImplicitParam()註解
@ApiOperation(value = "刪除", notes = "刪除指定gtUserId的使用者") @ApiImplicitParams({ @ApiImplicitParam(name = "gtUserId", value = "使用者ID", paramType = "path", required = true) }) @PostMapping(value = "/{gtUserId}", method = RequestMethod.DELETE) Admin delete(@PathVariable("gtUserId") String gtUserId);