SwaggerAPI注解详解

@Api:
作用在类上,用来标注该类具体实现内容。表示标识这个类是swagger的资源 。
参数:

  1. tags:可以使用tags()允许您为操作设置多个标签的属性,而不是使用该属性。
  2. description:可描述描述该类作用。

@ApiImplicitParam:
作用在方法上,表示单独的请求参数
参数:
3. name :参数名。
4. value : 参数的具体意义,作用。
5. required : 参数是否必填。
6. dataType :参数的数据类型。
7. paramType :查询参数类型,这里有几种形式:
8. 在这里我被坑过一次:当我发POST请求的时候,当时接受的整个参数,不论我用body还是query,后台都会报Body Missing错误。这个参数和SpringMvc中的@RequestBody冲突,索性我就去掉了paramType,对接口测试并没有影响

@ApiImplicitParams:
用于方法里面有多个@ApiImplicitParam

@ApiModel:
用于类,表示对类进行说明,用于参数用实体类接收;
@ApiModelProperty:
用于方法,字段 ,表示对model属性的说明或者数据操作更改
@ApiOperation:
用于方法,表示一个http请求的操作 。
@ApiResponse:
用于方法,描述操作的可能响应。

@ApiResponses:
用于方法,一个允许多个ApiResponse对象列表的包装器。
@ApiParam:
用于方法,参数,字段说明,表示对参数的添加元数据(说明或是否必填等)

@Authorization:
声明要在资源或操作上使用的授权方案。

@AuthorizationScope:
介绍一个OAuth2授权范围。

@ResponseHeader:
响应头设置,使用方法。


作者:都让你们叫老了
来源:CSDN
原文:https://blog.csdn.net/java_yes/article/details/79183804
版权声明:本文为博主原创文章,转载请附上博文链接!

  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 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、付费专栏及课程。

余额充值