在从Swagger 2.0规范迁移到OpenAPI 3.0规范时,上述注解分别需要改为以下内容:
原Swagger 2.0注解 | OpenAPI 3.0对应注解 | 说明 |
---|---|---|
@Api |
@Tag |
@Api 用于对控制器类进行分组和描述,@Tag 在OpenAPI 3.0中功能类似,用于标记一组相关的API操作,可添加名称和描述 |
@ApiModel |
@Schema |
@ApiModel 用于描述数据模型,@Schema 在OpenAPI 3.0中同样用于描述数据模型,可添加描述等信息 |
@ApiModelProperty |
@Schema |
@ApiModelProperty 用于描述数据模型中的字段属性,在OpenAPI 3.0中,@Schema 也可用于描述模型字段,指定字段的描述、示例值等 |
@ApiOperation |
@Operation |
@ApiOperation 用于描述控制器方法(API操作),@Operation 在OpenAPI 3.0中用于对API操作进行说明,可设置摘要、描述等属性 |