Swagger2 注解

本文详细解析了SpringBoot中使用Swagger生成API文档的各类注解,包括@Api、@ApiOperation、@ApiImplicitParams等的用途及参数说明,帮助开发者快速掌握API文档的自动生成技巧。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

  1. @Api 用在请求类上,表示对类的说明
    1. tags = "说明该类的作用,可以在UI洁面霜行看到的注解"
    2. value = "该参数没什么意义,在UI界面上也看到,所以不需要配置”
  2. @ApiOperation:用在请求的方法上,说明方法的用途 作用
    1. value:说明方法的用途,作用(此说明再xxx-controller下,点击才能看到)
    2. notes:方法的备用说明 (当有此值时:该接口说明会到页面中的主界面上)
    3. tags:此参数不应该用到方法上,不然会在首页中独立展示为一个接口,这个接口与存在在controller文件中的接口描述相同,冗余
  3. @ApiImplicitParams:用在请求的方法上,表示一组参数说明
    1. @ApiImplictParam:用在@ApliImplicitParams 注解中,指定一个请求参数的各个方面
      1. name:参数名
      2. value:参数的汉字说明。
      3. required:是否必传
      4. paramType:参数类型(参数放置的位置)
        1. header:请求参数的获取 @RequestHeader
        2. query : 请求参数的获取 @RequestParam
        3. path :用于Restful接口,请求参数的获取@PathVariable
        4. body (不常用)
        5. form(不常用)
      5. dataType:参数类型。默认String,其他值DataType = “Integer”
      6. defaultValue:参数的默认值
  4. @ApiResponses:用在请求的方法上,表示一组响应
    1. @ApiResponse:用在@APIResponses中,一般用于表达一个错误的响应信息
      1. code:数字,例如400
      2. message:信息,例如“请求参数没有填好”
      3. response:抛出异常的类
  5. @ApiModel:用于响应类上,表示一个返回响应数据的信息(这种一般用在post创建的时候,使用@RequestBody这样的场景,请求参数无法使用@ApiImplicitParam注解进行描述的时候)
    1. @ApiModelProperty:用在属性上,描述响应类的属性
  6. @ApiIgnore 忽视方法(不在UI界面上展示这个方法)

 

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值