Passe o código de um DTO, POJO ou record Java e receba o JSON que o setup padrão do Jackson no Spring Boot provavelmente geraria. As chaves vêm dos campos declarados, com @JsonProperty, @JsonIgnore, @JsonIgnoreProperties e as exclusões de static/transient aplicados.
Use para gerar um exemplo do Swagger ou um payload de exemplo para o frontend a partir do DTO de request ou response de um controller, ou só para conferir quais chaves uma classe com @Data do Lombok vai emitir.
static class, record e enum na mesma entrada para que os campos que as referenciam sejam preenchidos com a estrutura delas.Tipo raiz em Automático, é escolhida a classe que nenhuma outra usa como tipo de campo. Quando as entities se referenciam, escolha a que você quer na lista.@Schema(example = ...), um snippet do REST Docs ou o body de request do MockMvc.@Data
@JsonIgnoreProperties({"password"})
public class MemberResponse {
private Long memberId;
@JsonProperty("nick_name")
private String nickname;
private String password;
private Grade grade = Grade.SILVER;
private LocalDate birthDate;
private List<Address> addresses;
private static final long serialVersionUID = 1L;
public enum Grade { BRONZE, SILVER, GOLD }
public record Address(String zipCode, String city, boolean primary) {}
}{
"memberId": 0,
"nick_name": "",
"grade": "SILVER",
"birthDate": "1970-01-01",
"addresses": [
{
"zipCode": "",
"city": "",
"primary": false
}
]
}password é removido pelo @JsonIgnoreProperties({"password"}) no nível da classe, e o serialVersionUID static final nunca aparece. O inicializador Grade.SILVER é lido, então grade fica "SILVER" em vez da primeira constante do enum. O record Address aninhado se expande num array de objetos.
@JsonProperty("x") ou @JsonProperty(value = "x").@JsonIgnore, chaves listadas num @JsonIgnoreProperties({...}) no nível da classe e campos static ou transient.record do Java 16+, declarações aninhadas de static class e campos herdados via extends (campos do pai primeiro).@JsonProperty("x") numa constante muda a string para x.LocalDateTime → 1970-01-01T00:00:00, LocalDate → 1970-01-01, Instant/OffsetDateTime/ZonedDateTime → string ISO terminando em Z, java.util.Date/Timestamp → 1970-01-01T00:00:00.000+00:00.BigDecimal e Long viram 0, Optional<T> é desembrulhado para T, byte[] vira uma string Base64, e UUID e o ObjectId do MongoDB recebem valores bem formados.List, Set e arrays recebem um elemento de exemplo; um map como Map<Long, V> com chave numérica usa "0", caso contrário "key".Valores de example escritos à mão ficam desatualizados toda vez que um campo é adicionado ao DTO. Gere o JSON a partir do código do DTO e refine os valores a partir daí, para que nenhuma chave fique faltando ou com erro de digitação.
Crie o JSON de request direto do DTO de @RequestBody e cole num text block (""") no seu teste. Chaves renomeadas com @JsonProperty já vêm aplicadas, igual ao binding real.
Devs de frontend que não leem o código do backend recebem a estrutura JSON do endpoint direto, em vez de terem que interpretar uma classe Java.
= "guest", = 100, = true) ou uma constante de enum (= Grade.SILVER); qualquer outra coisa, como new ArrayList<>() ou uma chamada de método, cai no placeholder do tipo.getFullName() ou boolean isVip(), são adicionados como propriedades do jeito que o Jackson faz, respeitando @JsonIgnore/@JsonProperty nesse getter. Por outro lado, um campo private sem getter é considerado visível (como acontece com @Getter/@Data do Lombok).@JsonNaming(SnakeCaseStrategy.class), spring.jackson.property-naming-strategy) e padrões de data do @JsonFormat não são aplicados.@JsonValue em enums não são avaliados, então esses enums continuam mostrando a constante (ou o nome do @JsonProperty dela).Page<T>/Slice<T> do Spring Data são simplificados para um array de elementos; a serialização real de Page é um objeto com content, pageable e mais.@Data ou @Getter do Lombok?Sim. As chaves são montadas a partir dos campos declarados, então getters e setters que o Lombok gera em tempo de compilação não precisam estar no código.
LocalDateTime é uma string e não um array de números?O Spring Boot registra o jackson-datatype-jsr310 e desativa o WRITE_DATES_AS_TIMESTAMPS por padrão, o que gera strings ISO; o exemplo segue esse padrão. Um ObjectMapper do Jackson puro pode, em vez disso, escrever um array como [1970,1,1,0,0].
Entities têm a mesma estrutura de campos, então o parse funciona. Associações bidirecionais como @OneToMany entrariam em loop, então são expandidas uma vez e depois cortadas com null ou um array vazio. Também existe uma página dedicada Spring Boot JPA → JSON.
@JsonIgnore estiver num setter ou no getter de um campo existente?Anotações na declaração de um campo sempre se aplicam, e anotações num getter só se aplicam quando não existe campo com esse nome. @JsonIgnore num setter, ou no getter de um campo declarado, não é aplicado, então mova para o campo para ver o efeito.