swagger注解

  • @Api() :用于类;表示标识这个类是swagger的资源

    tags–表示说明
    value–也是说明,可以使用tags替代
    在这里插入图片描述
    效果:
    在这里插入图片描述

  • @ApiOperation() 用于方法;表示一个http请求的操作

    value用于方法描述
    notes用于提示内容
    tags可以重新分组(视情况而用)
    在这里插入图片描述
    效果:
    在这里插入图片描述

  • @ApiParam() 用于方法,参数,字段说明;表示对参数的添加元数据(说明或是否必填等)

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

  • @ApiModel()用于类 :表示对类进行说明,用于参数用实体类接收

    value–表示对象名
    description–描述

  • @ApiModelProperty()用于方法,字段; 表示对model属性的说明或者数据操作更改

    value–字段说明
    name–重写属性名字
    dataType–重写属性类型
    required–是否必填
    example–举例说明
    hidden–隐藏

  • @ApiIgnore()用于类或者方法上,可以不被swagger显示在页面上

  • @ApiImplicitParam() 用于方法 :表示单独的请求参数

  • @ApiImplicitParams() 用于方法,包含多个

  • @ApiImplicitParam

    name–参数ming
    value–参数说明
    dataType–数据类型
    paramType–参数类型
    example–举例说明
    在这里插入图片描述
    如果在controller方法上用@ApiImplicitParam()指明了参数,则controller方法中不必再指明参数

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

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值