¡Convierte entidades JPA en JSON!

¡Introduce entidades JPA para generar JSON de ejemplo! Compatible con JPA @Entity, Hibernate, Spring Boot. Útil para documentar APIs y cuerpos de petición de prueba (mock request body).
JPA
Resultado
 

¡Convierte entidades JPA en JSON!

Pega clases @Entity de JPA de Spring Boot y mira el JSON de ejemplo con la forma que produce Jackson cuando un controller devuelve esas entidades. Los nombres de campo, @JsonIgnore y @JsonProperty, los campos heredados de un @MappedSuperclass y los tipos de fecha de Java 8 se manejan según la configuración de Jackson por defecto de Spring Boot.

Úsalo para ejemplos de REST Docs o Swagger, bodies de petición de Postman, o para auditar qué campos se filtran cuando se expone una entidad sin DTO.

Cómo usar

  1. Pega las clases de entidad en el cuadro JPA. Los imports y las anotaciones de Lombok pueden quedarse; incluye las clases padre, las entidades relacionadas y los enums para que se rellenen sus valores.
  2. La clase que ninguna otra referencia pasa a ser la raíz. Cuando las entidades se referencian entre sí, se elige la clase public.
  3. Copia el resultado en tu test o tu documentación.

Ejemplo

Entrada (Java · JPA)
@MappedSuperclass
public abstract class BaseEntity {
    @Id @GeneratedValue
    private Long id;
    private LocalDateTime createdAt;
}

@Entity
public class Appointment extends BaseEntity {
    private LocalDate visitDate;
    private BigDecimal fee;
    @Enumerated(EnumType.STRING)
    private Status status;
    @ManyToOne(fetch = FetchType.LAZY)
    private Patient patient;

    public enum Status { BOOKED, DONE, CANCELED }
}

@Entity
class Patient extends BaseEntity {
    private String name;
    @JsonIgnore
    private String residentNumber;
    @OneToMany(mappedBy = "patient")
    private List<Appointment> appointments;
}
Salida (JSON)
{
  "id": 0,
  "createdAt": "1970-01-01T00:00:00",
  "visitDate": "1970-01-01",
  "fee": 0,
  "status": "BOOKED",
  "patient": {
    "id": 0,
    "createdAt": "1970-01-01T00:00:00",
    "name": "",
    "appointments": []
  }
}

Appointment y Patient se referencian entre sí, así que la clase public Appointment es la raíz y Patient.appointments se corta a un array vacío en lugar de entrar en un bucle infinito. id y createdAt de BaseEntity van primero, y residentNumber desaparece por @JsonIgnore. LocalDateTime es una cadena ISO sin offset, y el enum muestra su primera constante, "BOOKED".

Funciones compatibles

  • Se omiten los campos static y transient y los campos con @JsonIgnore, así como los nombres listados en un @JsonIgnoreProperties({"..."}) a nivel de clase.
  • @JsonProperty("doctor_name") renombra la clave JSON.
  • Cuando la clase padre (@MappedSuperclass o cualquier extends) está en la entrada, sus campos van primero.
  • Un valor por defecto de la entidad como private Status status = Status.ACTIVE; o private int visits = 0; aparece con ese valor, y los getters calculados sin campo detrás (public int getAge()) aparecen como claves adicionales, tal como los emitiría Jackson.
  • La salida de fechas sigue los valores por defecto de Spring Boot: LocalDate → 1970-01-01, LocalDateTime → 1970-01-01T00:00:00, java.util.Date → 1970-01-01T00:00:00.000+00:00.
  • Los wrappers numéricos como BigDecimal y Long dan 0, UUID un UUID todo ceros, y byte[] la cadena base64 "AA==".
  • List/Set dan un array de un elemento, Map<Long, String> da un objeto con la clave correspondiente ({"0": ""}), y Optional<T> se desenvuelve a su valor interior.
  • Las asociaciones bidireccionales (@OneToMany con @ManyToOne) se cortan con null o un array vacío donde vuelven sobre sí mismas.

Casos de uso

Ejemplos de Spring REST Docs y Swagger

Genera el JSON para @Schema(example = ...) o para snippets de documentación directamente a partir de la entidad, y vuelve a pegarla cada vez que cambien los campos para mantener la documentación al día.

Auditar entidades expuestas

Si devuelves entidades sin DTOs, comprueba si campos como contraseñas o números de identificación nacional acaban en las respuestas. Los campos de la salida son los que Jackson serializaría.

Bodies de petición para MockMvc

Usa la salida como esqueleto para mockMvc.perform(post("/appointments").content(...)), quitando el id generado y los timestamps antes de rellenar los valores.

Notas y limitaciones

  • El Jackson real entra en recursión infinita (StackOverflowError) con las asociaciones bidireccionales. Si la salida parece cortada, es la señal para usar @JsonManagedReference/@JsonBackReference, @JsonIgnore o un DTO.
  • Jackson no ignora por defecto la anotación @Transient de JPA, así que esos campos se quedan en la salida; solo se eliminan los campos con la palabra clave transient de Java.
  • En la práctica, las asociaciones FetchType.LAZY pueden fallar al serializarse como proxies de Hibernate; la salida supone que todo está cargado.
  • Los campos cuya clase no está en la entrada aparecen como null, y no se aplican las restricciones de @Column como nullable o length.

Preguntas frecuentes

¿De verdad las fechas deben ser cadenas y no arrays como [2024,1,1]?

Spring Boot desactiva WRITE_DATES_AS_TIMESTAMPS, así que LocalDateTime se escribe como cadena ISO. Un ObjectMapper construido a mano con solo JavaTimeModule registrado puede escribir arrays en su lugar.

¿Aparecen todos los campos aunque no haya @Getter de Lombok?

La herramienta trabaja a partir de las declaraciones de campos. El Jackson real serializa por defecto a través de getters (o campos públicos), así que los campos privados sin getter pueden faltar en las respuestas reales.

¿Puedo pegar también clases @Document de MongoDB?

Siguen las mismas reglas de Jackson, pero las particularidades propias de MongoDB como ObjectId y @Field se tratan en la página de Spring Data MongoDB a JSON.