Swagger注解-@Api

最新推荐文章于 2025-05-13 09:31:29 发布

原创最新推荐文章于 2025-05-13 09:31:29 发布 · 5.5k 阅读

CC 4.0 BY-SA版权

文章标签：

12 篇文章

订阅专栏

11 篇文章

订阅专栏

本文深入解析Swagger注解的使用，包括@ApiOperation、@ApiImplicitParams等，指导如何通过这些注解在SpringBoot项目中生成清晰的API文档，适用于REST接口的开发与维护。

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

使用场景

在 Rest 接口类上边使用。

标记类为 Swagger 资源类，运行时有效。

属性名称	数据类型	默认值	说明
value	String	“”	隐式设置操作的标记，遗留支持(读取 description)
tags	String[]	“”	对接口进行分组
produces	String	“”	采用逗号分隔的 content types,例如:application/json,application/xml 生成JSON和XML的输出
consumes	String	“”	采用逗号分隔的 content types，例如: application/json,application/xml 会接收JSON和XML的输入
protocols	String	“”	采用逗号分隔的可用协议，例如:http,https,ws,wss
authorizations	Authorization[]	“”	授权列表
hidden	boolean	false	隐藏此资源下的操作, 和 @ApiOperation 注解中的 hidden 组合使用可以隐藏改接口