Swagger2与openAPI3主机更改说明

原创于 2023-03-23 11:46:00 发布 · 523 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#java #mysql #spring

SpringBoot 同时被 2 个专栏收录

32 篇文章

订阅专栏

Java

14 篇文章

订阅专栏

文章详细介绍了如何使用Swagger2和ApiFox进行接口文档的注解，包括在Controller层用@ApiOperation定义接口方法描述，@ApiImplicitParams和@ApiImplicitParam注解方法参数，以及如何使用@ApiIgnore或@Hidden来隐藏特定参数或操作。同时，文章还提到了在实体类上使用@ApiModel和@ApiModelProperty来处理数据模型。

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

1 注解对应修改说明

Swagger2	ApiFox	标注位置
@Api	@Tag(name = “接口类名”,description = “接口类描述”)	Controller 控制层
@ApiOperation	@Operation(summary =“接口方法描述”)	Controller 控制层
@ApiImplicitParams	@Parameters	Controller 控制层的方法参数参数
@ApiImplicitParam	@Parameter(description=“参数描述”)	Controller 控制层 @Parameters 里
@ApiParam	@Parameter(description=“参数描述”)	Controller 控制层的方法参数参数
@ApiIgnore	@Parameter(hidden = true) 或 @Operation(hidden = true) 或 @Hidden	配合使用
@ApiModel	@Schema	Entity实体类上 vo do 等
@ApiModelProperty	@Schema	Entity实体类上 vo do 等