SpringBoot 整合 Swagger2 自动生成API文档

Swagger简介

Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

Swagger官网:https://swagger.io

常用注解

  • @Api 用于类,表示标识这个类是swagger的资源
  • @ApiOperation 用于方法,表示一个http请求的操作
  • @ApiParam 用于方法,参数,字段说明,表示对参数的添加元数据(说明或是否必填等)
  • @ApiModel 用于类,表示对类进行说明,用于参数用实体类接收
  • @ApiModelProperty 用于方法,字段,表示对model属性的说明或者数据操作更改
  • @ApiIgnore 用于类,方法,方法参数,表示这个方法或者类被忽略
  • @ApiImplicitParam 用于方法,表示单独的请求参数
  • @ApiImplicitParams 用于方法,包含多个 @ApiImplicitParam

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值