2025年swagger2注解（swagger2注解无效）

科技前沿 • 2025-04-30 19:22 • 阅读 48

大家好，我是讯享网，很高兴认识大家。

 <svg xmlns="http://www.w3.org/2000/svg" style="display: none;"> <path stroke-linecap="round" d="M5,0 0,2.5 5,5z" id="raphael-marker-block" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"></path> </svg> <p></p>

讯享网

以创建一个Controller，定义一个接口，讲述Swagger2的常用注解

@Api【定义Controller请求类】

讯享网

@Api 注解的主要作用是对Controller，也可以称之为对请求类做一个描述，它有几个常用参数，下面解释一下它们的用处

参数名描述tags用于表示该请求类在文档中的标签名称description详细描述position设置该请求类在文档中的位置顺序protocols协议类型，如: http, httpshidden该文档是否隐藏，默认为tree

效果图：

在这里插入图片描述
讯享网

@ApiOperation【描述接口说明】

@ApiOperation 注解的主要是对接口做出描述，它有几个常用参数，下面解释一下它们的用处

参数名描述value描述接口的作用notes接口的备注

效果图：

在这里插入图片描述

@ApiImplicitParams【接口的一组入参参数】、@ApiImplicitParam【描述接口中单个参数说明】

讯享网

@ApiImplicitParams 注解的作用就是描述接口中多个参数

@ApiImplicitParam 是描述单个参数说明，它有几个常用参数，下面解释一下它们的用处

参数名描述name参数名value参数备注required该参数是否必穿paramType参数放在哪个地方【path（restful接口）、query、body、header、form】dataType参数数据类型defaultValue参数默认值

效果图：

在这里插入图片描述

@ApiResponses【一组响应状态码与描述】、@ApiResponse【响应状态码与描述】

@ApiResponses 注解的作用就是描述接口多个响应状态

@ApiResponse 是单个响应状态码与描述，它有几个常用参数，下面解释一下它们的用处

参数名描述code响应状态码message响应说明

效果图：

在这里插入图片描述

@ApiModel【描述入参对象与出参对象】、@ApiModelProperty【描述对象中单个参数】

讯享网

返回对象：

@ApiModel 注解的作用是描述入参与出参对象

@ApiModelProperty 是描述单个参数，它有几个常用参数，下面解释一下它们的用处

参数名描述value参数名required参数是否必传position参数在文档中的位置

效果图：

在这里插入图片描述

End

2025年swagger2注解（swagger2注解无效）

@Api【定义Controller请求类】

@ApiOperation【描述接口说明】

@ApiImplicitParams【接口的一组入参参数】、@ApiImplicitParam【描述接口中单个参数说明】

@ApiResponses【一组响应状态码与描述】、@ApiResponse【响应状态码与描述】

@ApiModel【描述入参对象与出参对象】、@ApiModelProperty【描述对象中单个参数】

相关推荐