@ApiModel注解升级成@Schema注解

@ApiModel@ApiModelPropertySwagger 2 (即 springfox-swagger)中的注解。

在升级到 Springfox 3.0.0 或迁移到 SpringDoc OpenAPIspringdoc-openapi)时,这些注解发生了变化:

✅ 升级后的注解(使用 SpringDoc OpenAPI / OpenAPI 3)

Swagger 2 (Springfox) SpringDoc OpenAPI (OpenAPI 3)
@ApiModel @Schema
@ApiModelProperty @Schema

📌 用法对比

Swagger 2(旧版)
java 复制代码
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

@ApiModel(description = "用户信息")
public class User {
    @ApiModelProperty(value = "用户ID", example = "1")
    private Long id;

    @ApiModelProperty(value = "用户名", required = true)
    private String username;
}
SpringDoc OpenAPI(新版)
java 复制代码
import io.swagger.v3.oas.annotations.media.Schema;

@Schema(description = "用户信息")
public class User {
    @Schema(description = "用户ID", example = "1")
    private Long id;

    @Schema(description = "用户名", requiredMode = Schema.RequiredMode.REQUIRED)
    private String username;
}

🔁 迁移说明

  1. 替换依赖 : 如果从 springfox 迁移到 springdoc,需要移除 springfox-swagger2springfox-swagger-ui

    xml 复制代码
    <dependency>
        <groupId>org.springdoc</groupId>
        <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
        <version>2.8.13</version>
    </dependency>
  2. 替换注解

    • 所有 @ApiModel@Schema
    • 所有 @ApiModelProperty@Schema
    • required = truerequiredMode = Schema.RequiredMode.REQUIRED
  3. 访问地址

    • Swagger UI 地址从 /swagger-ui.html 变为 /swagger-ui.html(新版路径可能略有不同,通常是 /swagger-ui/index.html

✅ 总结

目的 旧注解(Swagger 2) 新注解(OpenAPI 3 / SpringDoc)
类说明 @ApiModel @Schema
字段说明 @ApiModelProperty @Schema

所以,@ApiModel@ApiModelProperty 的升级版本注解都是 @Schema

相关推荐
superlls4 小时前
(场景题)Java 导出 Excel 的两种方式
java·开发语言·后端·excel
harmful_sheep5 小时前
springMvc
java
一只小透明啊啊啊啊5 小时前
Java电商项目中的概念: 高并发、分布式、高可用、微服务、海量数据处理
java·分布式·微服务
2401_841495647 小时前
【数据结构】基于Prim算法的最小生成树
java·数据结构·c++·python·算法·最小生成树·prim
木井巳9 小时前
[Java数据结构和算法] HashMap 和 HashSet
java·数据结构·1024程序员节
祈祷苍天赐我java之术10 小时前
解析常见的限流算法
java·数据结构·算法
摇滚侠10 小时前
IDEA 启动前端项目 IDEA 切换分支
java·ide·intellij-idea
元直数字电路验证10 小时前
Jakarta EE开发中,如何配置IntelliJ IDEA的远程调试?
java·eureka·intellij-idea
石头wang10 小时前
idea字体的问题(idea应用本身的字体问题)
java·ide·intellij-idea