Convertissez des entités JPA en JSON !

Saisissez des entités JPA pour générer un JSON d'exemple ! Compatible avec JPA @Entity, Hibernate, Spring Boot. Pratique pour documenter une API et créer des corps de requête de test (mock request body).
JPA
Résultat
 

Convertissez des entités JPA en JSON !

Collez des classes @Entity JPA de Spring Boot et voyez un JSON d'exemple ayant la forme que produit Jackson quand un contrôleur renvoie ces entités. Noms de champs, @JsonIgnore et @JsonProperty, champs hérités d'une @MappedSuperclass et types de date Java 8 sont tous traités selon la configuration Jackson par défaut de Spring Boot.

Utilisez-le pour des exemples REST Docs ou Swagger, des corps de requête Postman, ou pour vérifier quels champs fuient quand une entité est exposée sans DTO.

Mode d'emploi

  1. Collez les classes d'entité dans le champ JPA. Imports et annotations Lombok peuvent rester ; incluez les classes parentes, les entités liées et les enums pour que leurs valeurs soient remplies.
  2. La classe qu'aucune autre ne référence devient la racine. Quand des entités se référencent mutuellement, c'est la classe public qui est choisie.
  3. Copiez le résultat dans votre test ou votre documentation.

Exemple

Entrée (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;
}
Sortie (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 et Patient se référencent mutuellement : la classe public Appointment est donc la racine, et Patient.appointments est coupé en tableau vide au lieu de boucler indéfiniment. id et createdAt de BaseEntity viennent en premier, et residentNumber a disparu à cause de @JsonIgnore. LocalDateTime est une chaîne ISO sans décalage, et l'enum affiche sa première constante, "BOOKED".

Fonctionnalités prises en charge

  • Les champs static et transient et les champs @JsonIgnore sont ignorés, tout comme les noms listés dans un @JsonIgnoreProperties({"..."}) de classe.
  • @JsonProperty("doctor_name") renomme la clé JSON.
  • Quand la classe parente (@MappedSuperclass ou tout extends) figure dans l'entrée, ses champs viennent en premier.
  • Une valeur par défaut d'entité comme private Status status = Status.ACTIVE; ou private int visits = 0; apparaît avec cette valeur, et les getters calculés sans champ associé (public int getAge()) apparaissent comme clés supplémentaires, comme Jackson les émettrait.
  • La sortie des dates suit les réglages par défaut de Spring Boot : LocalDate → 1970-01-01, LocalDateTime → 1970-01-01T00:00:00, java.util.Date → 1970-01-01T00:00:00.000+00:00.
  • Les wrappers numériques comme BigDecimal et Long donnent 0, UUID un UUID entièrement à zéro, et byte[] la chaîne base64 "AA==".
  • List/Set donnent un tableau d'un élément, Map<Long, String> donne un objet aux clés adaptées ({"0": ""}), et Optional<T> est déballé vers sa valeur interne.
  • Les associations bidirectionnelles (@OneToMany avec @ManyToOne) sont coupées avec null ou un tableau vide là où elles reviennent sur elles-mêmes.

Cas d'utilisation

Exemples Spring REST Docs et Swagger

Générez le JSON pour @Schema(example = ...) ou des snippets de documentation directement à partir de l'entité, et recollez-la à chaque changement de champs pour garder la doc synchronisée.

Auditer les entités exposées

Si vous renvoyez des entités sans DTO, vérifiez si des champs comme les mots de passe ou les numéros d'identité nationale se retrouvent dans les réponses. Les champs de la sortie sont ceux que Jackson sérialiserait.

Corps de requête MockMvc

Servez-vous de la sortie comme squelette pour mockMvc.perform(post("/appointments").content(...)), en retirant l'id et les timestamps générés avant de remplir les valeurs.

Remarques et limites

  • Le vrai Jackson boucle à l'infini (StackOverflowError) sur les associations bidirectionnelles. Si la sortie semble coupée, c'est le signal pour @JsonManagedReference/@JsonBackReference, @JsonIgnore ou un DTO.
  • L'annotation JPA @Transient n'est pas ignorée par Jackson par défaut : ces champs restent donc dans la sortie ; seuls les champs portant le mot-clé Java transient sont retirés.
  • En pratique, les associations FetchType.LAZY peuvent échouer à la sérialisation en tant que proxies Hibernate ; la sortie suppose que tout est chargé.
  • Les champs dont la classe ne figure pas dans l'entrée apparaissent en null, et les contraintes @Column comme nullable ou length ne sont pas appliquées.

FAQ

Les dates doivent-elles vraiment être des chaînes et non des tableaux comme [2024,1,1] ?

Spring Boot désactive WRITE_DATES_AS_TIMESTAMPS : LocalDateTime est donc écrit sous forme de chaîne ISO. Un ObjectMapper construit à la main avec seulement JavaTimeModule enregistré peut écrire des tableaux à la place.

Tous les champs apparaissent-ils même sans @Getter de Lombok ?

L'outil travaille à partir des déclarations de champs. Le vrai Jackson sérialise par défaut via les getters (ou les champs publics) : des champs privés sans getter peuvent donc manquer dans les réponses réelles.

Puis-je aussi coller des classes MongoDB @Document ?

Elles suivent les mêmes règles Jackson, mais les particularités propres à MongoDB comme ObjectId et @Field sont traitées sur la page Spring Data MongoDB vers JSON.