Swagger注解记录

                                                    由于Swagger主要是通过注解来标注文档内容的,这里我们先来学习下它的常用注解。

注解名称

描述

常用属性

@Api

用于类,标识这个类是Swagger的资源

tags:给该类下的接口设置标签

@Tag

可用于类或方法,声明一个标签

name:标签名称
description:标签描述

@ApiIgnore

忽略该类的文档生成

value:添加备注

@ApiOperation

用于方法,用于描述一个HTTP请求方法

value:给方法添加描述

@ApiParam

用于参数,用于描述请求参数

value:参数描述
name:参数名称
defaultValue:参数默认值
required:参数是否必填
allowableValues:参数允许范围
type:参数类型

@ApiImplicitParam

代表一个单个API操作,与@ApiImplicitParams联用

paramType:参数请求类型
dataTypeClass:参数值类型
其他类型同@ApiParam

@ApiImplicitParams

多个@ApiImplicitParam注解的集合

参数为@ApiImplicitParam数组

@ApiModel

用于类,声明一个Swagger的模型

value:模型名称
description:模型描述

@ApiProperty

用于参数,声明Swagger模型的属性或填充数据

value:属性描述
name:属性名称
allowableValues:允许值

@ApiResponse

用于描述一个可能的返回结果

responseCode:返回状态码
message:返回信息

@ApiResponses

@ApiResponse的集合

参数为@ApiResponse数组

posted @   佩洛君  阅读(27)  评论(0编辑  收藏  举报
相关博文:
阅读排行:
· 阿里最新开源QwQ-32B,效果媲美deepseek-r1满血版,部署成本又又又降低了!
· 开源Multi-agent AI智能体框架aevatar.ai,欢迎大家贡献代码
· Manus重磅发布:全球首款通用AI代理技术深度解析与实战指南
· 被坑几百块钱后,我竟然真的恢复了删除的微信聊天记录!
· 没有Manus邀请码?试试免邀请码的MGX或者开源的OpenManus吧
点击右上角即可分享
微信分享提示