Преобразуйте сущности JPA в JSON!

Введите сущности JPA, чтобы получить пример JSON! Поддержка: JPA @Entity, Hibernate, Spring Boot. Удобно для документации API и тестовых тел запросов (mock request body).
JPA
Результат
 

Преобразуйте сущности JPA в JSON!

Вставьте классы @Entity из Spring Boot JPA и посмотрите пример JSON в той форме, которую выдаёт Jackson, когда контроллер возвращает эти сущности. Имена полей, @JsonIgnore и @JsonProperty, поля, унаследованные от @MappedSuperclass, и типы дат Java 8 обрабатываются по стандартной настройке Jackson в Spring Boot.

Используйте для примеров REST Docs или Swagger, тел запросов в Postman или чтобы проверить, какие поля утекают наружу, когда сущность отдаётся без DTO.

Как пользоваться

  1. Вставьте классы сущностей в поле JPA. Импорты и аннотации Lombok можно оставить; добавьте родительские классы, связанные сущности и enum, чтобы их значения были заполнены.
  2. Корнем становится класс, на который не ссылается ни один другой класс. Если сущности ссылаются друг на друга, выбирается public-класс.
  3. Скопируйте результат в тест или документацию.

Пример

Вход (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;
}
Результат (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 и Patient ссылаются друг на друга, поэтому корень — public-класс Appointment, а Patient.appointments обрывается на пустом массиве вместо бесконечного цикла. id и createdAt из BaseEntity идут первыми, а residentNumber исчез из-за @JsonIgnore. LocalDateTime — ISO-строка без смещения, а enum показывает первую константу, "BOOKED".

Возможности

  • Поля static и transient и поля с @JsonIgnore пропускаются, как и имена, перечисленные в @JsonIgnoreProperties({"..."}) на уровне класса.
  • @JsonProperty("doctor_name") переименовывает ключ JSON.
  • Если родительский класс (@MappedSuperclass или любой extends) есть во вводе, его поля идут первыми.
  • Значение по умолчанию в сущности, вроде private Status status = Status.ACTIVE; или private int visits = 0;, отображается как это значение, а вычисляемые геттеры без поля (public int getAge()) появляются как дополнительные ключи — так, как их выдал бы Jackson.
  • Вывод дат следует умолчаниям Spring Boot: LocalDate → 1970-01-01, LocalDateTime → 1970-01-01T00:00:00, java.util.Date → 1970-01-01T00:00:00.000+00:00.
  • Числовые обёртки вроде BigDecimal и Long дают 0, UUID — UUID из одних нулей, а byte[] — строку base64 "AA==".
  • List/Set дают массив из одного элемента, Map<Long, String> — объект с подходящим ключом ({"0": ""}), а Optional<T> разворачивается во внутреннее значение.
  • Двунаправленные связи (@OneToMany с @ManyToOne) обрываются на null или пустом массиве там, где они замыкаются.

Сценарии использования

Примеры для Spring REST Docs и Swagger

Генерируйте JSON для @Schema(example = ...) или сниппетов документации прямо из сущности и вставляйте заново при каждом изменении полей, чтобы документация не отставала.

Аудит открытых наружу сущностей

Если вы возвращаете сущности без DTO, проверьте, не попадают ли в ответы поля вроде паролей или номеров документов. Поля в выводе — это те, что сериализовал бы Jackson.

Тела запросов для MockMvc

Используйте вывод как каркас для mockMvc.perform(post("/appointments").content(...)), убрав сгенерированные id и метки времени, прежде чем заполнять значения.

Примечания и ограничения

  • Настоящий Jackson уходит в бесконечную рекурсию (StackOverflowError) на двунаправленных связях. Если вывод выглядит обрезанным, это сигнал применить @JsonManagedReference/@JsonBackReference, @JsonIgnore или DTO.
  • Аннотацию JPA @Transient Jackson по умолчанию не игнорирует, поэтому такие поля остаются в выводе; удаляются только поля с ключевым словом Java transient.
  • Связи FetchType.LAZY на практике могут не сериализоваться из-за прокси Hibernate; вывод предполагает, что всё загружено.
  • Поля, класс которых отсутствует во вводе, отображаются как null, а ограничения @Column вроде nullable или length не применяются.

Частые вопросы

Даты действительно должны быть строками, а не массивами вроде [2024,1,1]?

Spring Boot отключает WRITE_DATES_AS_TIMESTAMPS, поэтому LocalDateTime пишется ISO-строкой. Собранный вручную ObjectMapper, где зарегистрирован только JavaTimeModule, может вместо этого писать массивы.

Появляются ли все поля даже без Lombok @Getter?

Инструмент работает по объявлениям полей. Настоящий Jackson по умолчанию сериализует через геттеры (или публичные поля), так что приватные поля без геттеров могут отсутствовать в реальных ответах.

Можно ли вставлять и классы MongoDB @Document?

Они следуют тем же правилам Jackson, но особенности MongoDB вроде ObjectId и @Field разобраны на странице Spring Data MongoDB в JSON.