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:用在属性上,描述响应类的属性
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值