@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

相关推荐
Flittly16 小时前
【AgentScope Java新手村系列】(16)从RAG到多路检索
java·spring boot·spring
小兔崽子去哪了16 小时前
Java 生成二维码解决方案
java·后端
人活一口气20 小时前
从JVM调优到MCP协议:Java全栈技术体系深度总结与企业级架构实践
java·spring boot
NE_STOP1 天前
Vibe Coding -- 完整项目案例实操
java
荣码1 天前
GraphRAG:普通RAG只能回答"点"的问题,我踩了4个坑才搞懂
java·python
SimonKing1 天前
Google第三方授权登录
java·后端·程序员
明月光8181 天前
从一行 @Builder 说起:重新拾起 Java 的 Lombok、注解与 Builder 模式
java
考虑考虑1 天前
Mybatis实现批量插入
java·后端·mybatis
咖啡八杯1 天前
GoF设计模式——中介者模式
java·后端·spring·设计模式
青石路2 天前
记一次多JDK版本问题的排查,一坑套一坑,差点没爬上来
java