swagger2常用注解释义

@Api:用于请求类上,说明类的作用
    tags="说明该类的作用,显示在UI界面上"
    value="可不配置"

@ApiOperation:用于请求方法上,说明方法的用途及作用
    value="说明方法的用途、作用"
    notes="方法的备注说明"

@ApiImplicitParams:用于请求方法上,表示一组参数说明
@ApiImplicitParam:用于@ApiImplicitParams注解中或单独用于方法上,说明一个请求参数
        name:参数名
        value:参数的中文说明
        required:参数是否必须
        paramType:参数位置
            · header --> 请求参数的获取:@RequestHeader
            · query --> 请求参数的获取:@RequestParam
            · path(用于restful接口)--> 请求参数的获取:@PathVariable
            · body(json传参)
            · form(不常用)    
        dataType:参数类型,默认String    
        defaultValue:参数的默认值

@ApiResponses:用于请求的方法上,表示一组响应
@ApiResponse:用于@ApiResponses中或单独用于方法上,一般用于表达一个错误的响应信息
        code:数字,例如400
        message:信息,例如"请求参数没填好"
        response:抛出异常的类

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

猜你喜欢

转载自blog.csdn.net/quanaianzj/article/details/83141926
今日推荐