Swagger2 注解说明

@Api：用在请求的类上，表示对类的说明
tags="说明该类的作用，可以在UI界面上看到的注解"
value="该参数没什么意义，在UI界面上也看到，所以不需要配置"

 

@ApiOperation(value="获取用户列表", notes="获取全部用户列表")
//@ApiOperation(value,notes): 用在请求的方法上，说明方法的用途、作用
// value="说明方法的用途、作用"
//notes="方法的备注说明"

 

@ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User")

@ApiImplicitParams({
        @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long", paramType = "path"),
        @ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User")
    })

//@ApiImplicitParam: 用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
//name：参数名
//value：参数的汉字说明、解释
//required：参数是否必须传
//paramType：参数放在哪个地方
//	   · header --> 请求参数的获取：@RequestHeader
//	   · query --> 请求参数的获取：@RequestParam
//	   · path（用于restful接口）--> 请求参数的获取：@PathVariable
//	   · body（不常用）
//	   · form（不常用）
//dataType：参数类型，默认String，其它值dataType="Integer"
//defaultValue：参数的默认值