如何在OpenAPI Generator中通过YAML配置JPA外键关联？

一、当前配置的核心问题 #

1. @OneToMany注解位置错误：你把@OneToMany放在了主键codPerfil字段上，这个注解应该用于标记关联的集合字段，而非主键。
2. @OneToMany缺少必要参数：JPA的@OneToMany需要指定关联的目标实体（targetEntity），如果是双向关联还需配置mappedBy；单向关联则需要配合@JoinColumn指定外键字段。
3. 依赖缺失JPA核心组件：你的pom.xml里没有Spring Data JPA或JPA API依赖，这是生成数据库外键映射的基础。

二、正确的YAML配置示例 #

假设你要关联的目标实体是Usuario（对应OpenAPI定义中的usuario模型），修改后的YAML配置如下：

perfil:
  type: object
  x-class-extra-annotation: "@javax.persistence.Entity"
  properties:
    codPerfil:
      type: integer
      x-field-extra-annotation: "@javax.persistence.Id"
      example: 1
    descPerfil:
      type: string
      example: "管理员"
    descPerfilEus:
      type: string
      example: "Administratzailea"
    documentacion:
      type: string
      example: "admin_perfil.pdf"
    # 新增关联的集合字段，用于标记@OneToMany
    usuarios:
      type: array
      items:
        $ref: '#/components/schemas/usuario'
      x-field-extra-annotation: "@javax.persistence.OneToMany(targetEntity = Usuario.class, mappedBy = 'perfil', cascade = javax.persistence.CascadeType.ALL, fetch = javax.persistence.FetchType.LAZY)"

关键注解参数说明：

• targetEntity = Usuario.class：指定关联的目标实体类
• mappedBy = 'perfil'：双向关联时，指定对方实体中关联当前实体的字段名（需在Usuario模型中配置@ManyToOne关联Perfil）
• cascade = CascadeType.ALL：配置级联操作（可选，根据业务需求调整）
• fetch = FetchType.LAZY：配置懒加载策略（可选）

如果是单向关联（不需要在Usuario中反向关联Perfil），则将@OneToMany改为：

x-field-extra-annotation: "@javax.persistence.OneToMany(targetEntity = Usuario.class, cascade = javax.persistence.CascadeType.ALL, fetch = javax.persistence.FetchType.LAZY)"
x-field-extra-annotation2: "@javax.persistence.JoinColumn(name = 'cod_perfil_fk', referencedColumnName = 'codPerfil')"

三、补充必要的JPA依赖 #

在pom.xml中添加Spring Data JPA依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<!-- 需添加数据库驱动，比如H2/MySQL等，示例为MySQL -->
<dependency>
    <groupId>com.mysql</groupId>
    <artifactId>mysql-connector-j</artifactId>
    <scope>runtime</scope>
</dependency>

四、关联实体的配套配置（双向关联场景） #

如果是双向关联，需要在Usuario模型中配置@ManyToOne注解：

usuario:
  type: object
  x-class-extra-annotation: "@javax.persistence.Entity"
  properties:
    codUsuario:
      type: integer
      x-field-extra-annotation: "@javax.persistence.Id"
      example: 100
    nombre:
      type: string
      example: "张三"
    # 反向关联Perfil的字段
    perfil:
      $ref: '#/components/schemas/perfil'
      x-field-extra-annotation: "@javax.persistence.ManyToOne(fetch = javax.persistence.FetchType.LAZY)"
      x-field-extra-annotation2: "@javax.persistence.JoinColumn(name = 'cod_perfil_fk', referencedColumnName = 'codPerfil')"

五、验证生成结果 #

重新运行OpenAPI Generator后，生成的Perfil实体类中会包含正确的@OneToMany注解，数据库生成时会自动创建cod_perfil_fk外键，关联Usuario表和Perfil表的codPerfil字段。

内容的提问来源于stack exchange，提问作者mpy