Swagger核心注解总结(四)

一、前言

本文介绍了swagger的一些注解应用,有swagger2版本的和swagger3.0版本的注解,基本上差不多,在这里我只介绍了一些常用的注解和注解的一些参数等,想要了解更多可以去百度查找。

二、Swagger接口文档注解

在这里插入图片描述

1、@Api

作用: 使用在类上,表明是swagger资源,@Api拥有两个属性:valuetagscontroller中的所有接口生成的接口文档都会在tags这个list下;tags如果有多个值,会生成多个list,每个list都显示所有接口。
应用代码:

@Api(value="图书接口",tags = "图书管理")
@RestController
@RequestMapping(value = "/book")
public class BookController {
}

如下图所示:
在这里插入图片描述

2、@ApiOperation

作用: 用于在方法上,表示一个http请求的操作,用在项目的接口类的方法上。value用于方法描述,notes用于提示内容。
应用代码:

@ApiOperation(value = "获取所有的书", notes = "")
@PostMapping(value = "/list")
public Result booklist(){
    // 内容
}

3、@EnableOpenApi

作用: 在用到swagger3.0版本的时候就可以用到这个注解了,可以放在启动类上或者是swagger的配置文件上。

应用代码:

@Configuration
@EnableOpenApi
public class Swagger2Configuration {
    //放一些swagger的配置信息,添加项目接口版本号,指定controller类等。
}

4、@ApiImplicitParam

作用: 用在@ApiImplicitParams注解中,指定一个请求参数的各个方面

  • name:参数名

  • value:参数的汉字说明、解释

  • required:参数是否必须传

  • paramType:参数放在哪个地方

应用代码:

  @ApiOperation(value = "获取所有的书", notes = "")
  @PostMapping(value = "/list")
  @ApiImplicitParams({@ApiImplicitParam(name = "book", value = "所有的书", paramType = "Long")})
  public Result booklist(){
       
  }

5、@ApiImplicitParams

作用: 用在请求的方法上,表示一组参数说明,和@ApiImplicitParam配合使用。

应用代码:

  @ApiOperation(value = "获取所有的书", notes = "")
  @PostMapping(value = "/list")
  @ApiImplicitParams({@ApiImplicitParam(name = "book", value = "所有的书", paramType = "Long")})
  public Result booklist(){
       
  }

6、@ApiParam

作用: 使用在方法上或者参数上,字段说明;表示对参数的添加元数据(说明或是否必填等)。(目前不常用)

  • name–参数名
  • value–参数说明
  • required–是否必填

应用代码:

public class BookController {
     @ApiOperation(value="获取所有的书",tags={"获取所有的书copy"},notes="注意问题")
     @PostMapping(value = "/list")
     public Result getUserInfo(@ApiParam(name="id",value="用户id",required=true) Long id,@ApiParam(name="username",value="用户名") String username) {
      //可忽略业务逻辑
      List<Book> all = bookService.findAll();
      return new Result().success(200, all);
  }
}

7、@EnableSwagger2

作用: 在用到swagger2.0版本的时候就可以用到这个注解了,可以放在启动类上或者是swagger的配置文件上。

应用代码:

@Configuration
@EnableSwagger2
public class Swagger2Configuration {
    //放一些swagger的配置信息,添加项目接口版本号,指定controller类等。
}

暂时就整理以上七个注解吧,以后遇到其它的我再更新,整理累死个人,别忘了点赞、收藏、关注哦!
在这里插入图片描述

上一篇:Mybatis核心注解总结(三)

有什么问题欢迎私信和我交流。或者关注我的微信公众号码上言获得更多的学习。

微信公众号:码上言

  • 1
    点赞
  • 5
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

码上言

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值