@ApiOperation注解

@ApiOperation是Swagger中的注解,用于接口文档化,提供如value(接口说明)、tags(接口分组)、httpMethod(请求方式)、consumes(请求头类型)等属性,帮助开发者更好地定义和展示API接口信息。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

    @ApiOperation 注解是swagger里的,我们可以使用@ApiOperation注解来描述我们写的接口,该注解提供了很多属性供我们来描述接口信息。可供选择的属性如下:

属性名属性类型默认值作用
value()String接口说明
tags()String[]

                    该接口属于什么分组

             (可以是单个,也可以是多个)

notes()String接口的详细说明
httpMethod()String接口请求方式
prodeces()String接口请求头类型(输出)
tags()String[]

                    该接口属于什么分组

             (可以是单个,也可以是多个)

nickname()String接口别名
protocols()String网络请求协议(http、https等)
hidden()booleanfalse控制接口在Swagger界面中的显隐性
code()int200

                            接口状态码

(一般不用设置,Swagger会自动生成接口返回状态)

response()Class<?>接口返回类型
responseContainer()String接口返回数据类型
responseReference()String接口返回引用类型
consumes()String接口请求头类型(输入)

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值