swagger 各个注解的作用(详解)

这篇博客只是对swagger各个注解的作用进行说明,如果您还没将springBoot和swagger进行整合,请看我的这篇博客
https://blog.csdn.net/weixin_43610698/article/details/107391473
如果你已经整合完了,请忽略。

swagger2 注解说明
  • @Api() 作用于类,表示这个类是swagger管理的资源
属性说明:
tags--表示说明
value-- 同样时表示说明,可以使用tags替换
注:tags可以放多个值,多个值放在数组中
@Api(value="Api的 value 属性值说明",tags={"tags属性说明","tags可以使用数组"})
  • @ApiOperation() 作用于方法,表示一个http请求的操作
属性说明:
value--方法描述
notes--内容提示
tags可以重新分组(视情况而用)

@ApiOperation(value="获取用户信息",tags={"获取用户信息copy"},notes="注意问题点")
  • @ApiParam() 方法的参数,字段说明;表示对参数添加元数据
属性说明:
name--参数名
value--参数说明
required--是否必填
  • @ApiModel 对类的说明,用于参数用实体类接受
属性说明:
value–表示对象名
description–描述
都可省略

@ApiModel(value = "User对象", description = "")
  • @ApiModelProperty()用于方法,字段; 表示对model属性的说明或者数据操作更改
属性说明:
value--字段说明
name-- 重写属性名字
dataType--重写属性类型
required--是否必须填写
example --举例说明
hidden-- 隐藏

@ApiModelProperty(value = "姓名")
private String name;
  • @ApiIgnore()用于类或者方法上,可以不被swagger显示在页面上
  • @ApiImplicitParam() 用于方法(表示单个参数)
属性说明:
name–-参数名
value–-参数说明
dataType–-数据类型
paramType–-参数类型
example–-举例说明
@ApiImplicitParam(name = "id",value = "用户id",required = true)
  • @ApiImplicitParams() 用于方法(表示多个参数),包含多个 @ApiImplicitParam
@ApiImplicitParams({
  @ApiImplicitParam(name="name",value="用户名",dataType="string", paramType = "query"),
  @ApiImplicitParam(name="id",value="用户id",dataType="long", paramType = "query")})
  • 0
    点赞
  • 6
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Swagger是一种API文档生成工具,它可以根据代码自动生成API文档,并且可以通过Swagger UI进行查看和测试。Swagger注解是用来描述API信息的一种方式,它可以帮助Swagger生成准确的API文档。 下面是Swagger注解的使用详解: 1. @Api:用于描述API的基本信息,包括API的名称、描述、版本号等。 2. @ApiOperation:用于描述API的操作,包括HTTP请求方法、请求路径、请求参数、返回值等。 3. @ApiParam:用于描述API的参数信息,包括参数名称、参数类型、是否必须、默认值等。 4. @ApiModel:用于描述API的数据模型,包括模型名称、模型属性等。 5. @ApiModelProperty:用于描述API的数据模型属性,包括属性名称、属性类型、是否必须、默认值等。 6. @ApiIgnore:用于忽略API的某些信息,比如某个参数或返回值。 7. @ApiResponses:用于描述API的响应信息,包括响应状态码、响应描述、响应数据类型等。 8. @ApiResponse:用于描述API的单个响应信息,包括响应状态码、响应描述、响应数据类型等。 9. @ApiError:用于描述API的错误信息,包括错误码、错误描述、错误数据类型等。 10. @ApiImplicitParam:用于描述API的隐式参数,比如请求头、请求体等。 11. @ApiImplicitParams:用于描述API的多个隐式参数。 总之,Swagger注解提供了丰富的API描述功能,可以帮助我们更好地生成准确的API文档,提高API的可读性和可维护性。

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值