Converta entidades JPA em JSON!

Insira entidades JPA para gerar JSON de exemplo! Compatível com JPA @Entity, Hibernate, Spring Boot. Útil para documentar APIs e corpos de requisição de teste (mock request body).
JPA
Resultado
 

Converta entidades JPA em JSON!

Cole classes @Entity do JPA no Spring Boot e veja um JSON de exemplo no formato que o Jackson gera quando um controller retorna essas entities. Nomes de campo, @JsonIgnore e @JsonProperty, campos herdados de uma @MappedSuperclass e os tipos de data do Java 8 são tratados conforme o setup padrão do Jackson no Spring Boot.

Use para exemplos do REST Docs ou do Swagger, request bodies do Postman, ou para auditar quais campos vazam quando uma entity é exposta sem DTO.

Como usar

  1. Cole as classes de entity na caixa JPA. Imports e anotações do Lombok podem ficar; inclua as classes pai, as entities relacionadas e os enums para que os valores deles sejam preenchidos.
  2. A classe que nenhuma outra referencia vira a raiz. Quando as entities se referenciam, é escolhida a classe public.
  3. Copie o resultado para o seu teste ou documentação.

Exemplo

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;
}
Saída (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 e Patient se referenciam, então a classe public Appointment é a raiz e Patient.appointments é cortado num array vazio em vez de entrar em loop infinito. id e createdAt de BaseEntity vêm primeiro, e residentNumber some por causa do @JsonIgnore. LocalDateTime é uma string ISO sem offset, e o enum mostra a sua primeira constante, "BOOKED".

Recursos suportados

  • Campos static e transient e campos com @JsonIgnore são pulados, assim como nomes listados num @JsonIgnoreProperties({"..."}) no nível da classe.
  • @JsonProperty("doctor_name") renomeia a chave JSON.
  • Quando a classe pai (@MappedSuperclass ou qualquer extends) está na entrada, os campos dela vêm primeiro.
  • Um default da entity como private Status status = Status.ACTIVE; ou private int visits = 0; aparece com esse valor, e getters calculados sem campo correspondente (public int getAge()) aparecem como chaves extras, como o Jackson os emitiria.
  • A saída de datas segue os padrões do Spring Boot: LocalDate → 1970-01-01, LocalDateTime → 1970-01-01T00:00:00, java.util.Date → 1970-01-01T00:00:00.000+00:00.
  • Wrappers numéricos como BigDecimal e Long dão 0, UUID um UUID todo zerado e byte[] a string base64 "AA==".
  • List/Set dão um array de um elemento, Map<Long, String> dá um objeto com chave correspondente ({"0": ""}), e Optional<T> é desembrulhado para o valor interno.
  • Associações bidirecionais (@OneToMany com @ManyToOne) são cortadas com null ou um array vazio onde voltam ao início.

Casos de uso

Exemplos do Spring REST Docs e do Swagger

Gere o JSON para @Schema(example = ...) ou snippets de documentação direto da entity, e cole de novo sempre que os campos mudarem para manter a documentação em dia.

Auditar entities expostas

Se você retorna entities sem DTOs, confira se campos como senhas ou números de documento acabam nas respostas. Os campos na saída são os que o Jackson serializaria.

Request bodies do MockMvc

Use a saída como esqueleto para mockMvc.perform(post("/appointments").content(...)), removendo o id e os timestamps gerados antes de preencher os valores.

Observações e limitações

  • O Jackson real entra em recursão infinita (StackOverflowError) em associações bidirecionais. Se a saída parecer cortada, é o sinal para usar @JsonManagedReference/@JsonBackReference, @JsonIgnore ou um DTO.
  • A anotação @Transient do JPA não é ignorada pelo Jackson por padrão, então esses campos continuam na saída; só campos com a keyword transient do Java são removidos.
  • Associações FetchType.LAZY podem falhar ao serializar como proxies do Hibernate na prática; a saída assume que tudo está carregado.
  • Campos cuja classe não está na entrada aparecem como null, e restrições do @Column como nullable ou length não são aplicadas.

Perguntas frequentes

As datas devem mesmo ser strings e não arrays como [2024,1,1]?

O Spring Boot desativa o WRITE_DATES_AS_TIMESTAMPS, então o LocalDateTime é escrito como string ISO. Um ObjectMapper montado à mão só com o JavaTimeModule registrado pode escrever arrays.

Todos os campos aparecem mesmo sem o @Getter do Lombok?

A ferramenta trabalha a partir das declarações de campo. O Jackson real serializa via getters (ou campos públicos) por padrão, então campos privados sem getter podem não aparecer nas respostas reais.

Posso colar classes @Document do MongoDB também?

Elas seguem as mesmas regras do Jackson, mas as particularidades do MongoDB, como ObjectId e @Field, são tratadas na página Spring Data MongoDB para JSON.