OpenApi3.0注解说明

最新推荐文章于 2024-07-12 19:14:53 发布

~半颗心

最新推荐文章于 2024-07-12 19:14:53 发布

阅读量1.5k

点赞数

文章标签： java 开发语言

本文链接：https://blog.csdn.net/yuanye01/article/details/132062665

版权

本文介绍了OpenAPI3.0中的一些关键注解，包括@Tag、@Hidden、@ApiResponse，以及在方法上使用的@Schema、@Operation、@Parameter、@RequestBody和@Content。这些注解用于定义API文档、描述HTTP操作、参数和响应。

摘要由CSDN通过智能技术生成

注解代码位于 io.swagger.v3.oas.annotations 包里。

swagger 2	swagger 3
@Api	@Tag 或者 Tags
@ApiIgnore	@Parameter(hidden = true) 或 @Operation(hidden = true) 或 @Hidden
@ApiImplicitParam	@Parameter
@ApiImplicitParams	@Parameters
@ApiModel	@Schema
@ApiModelProperty	@Schema
@ApiOperation(value = “foo”, notes = “bar”)	@Operation(summary = “foo”, description = “bar”)
@ApiParam	@Parameter
@ApiResponse(code = 404, message = “foo”)	@ApiResponse(responseCode = “404”, description = “foo”)

用于说明或定义的标签。也可以作用于方法上

部分参数：

某个元素（API操作、实体类属性等）是否在 API 文档中隐藏。

API 的响应信息。也可以作用于方法上，一般常用于方法上

部分参数：

代码

关注