[Java知识库]Swagger--注解说明

1、

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

2、

@ApiOperation：用在请求的方法上，说明方法的用途、作用
    value="说明方法的用途、作用"
    notes="方法的备注说明"

3、

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

4、

@ApiModel()用于类，表示对类进行说明，用于参数用实体类接收 
	value：表示对象名 
	description：描述 

5、

@ApiModelProperty()用于字段； 表示对model属性的说明或者数据操作更改 
	value：字段说明 
	name：重写属性名字（实测没什么用，seagger会自动强制写属性名） 
	dataType：重写属性类型 （也没什么用，seagger会自动强制写属性类型）
	required：是否必填，Boolean类型，默认flase（必填字段会有个*）
	example：举例说明（可以给一个字段值示例）
	hidden：是否隐藏，Boolean类型，默认flase

6、

@ApiModel：用于响应类上，表示一个返回响应数据的信息
            （这种一般用在post创建的时候，使用@RequestBody这样的场景，
            请求参数无法使用@ApiImplicitParam注解进行描述的时候）
    @ApiModelProperty：用在属性上，描述响应类的属性