Ubah entitas JPA menjadi JSON!

Masukkan entitas JPA untuk membuat contoh JSON! Mendukung JPA @Entity, Hibernate, Spring Boot. Berguna untuk dokumentasi API dan body request uji (mock request body).
JPA
Hasil
 

Ubah entitas JPA menjadi JSON!

Tempel class @Entity JPA Spring Boot dan lihat contoh JSON dengan bentuk yang dihasilkan Jackson ketika controller mengembalikan entity tersebut. Nama field, @JsonIgnore dan @JsonProperty, field yang diwarisi dari @MappedSuperclass, serta tipe tanggal Java 8 semuanya ditangani sesuai setup Jackson default Spring Boot.

Gunakan untuk contoh REST Docs atau Swagger, body request Postman, atau untuk mengaudit field mana yang bocor ketika entity diekspos tanpa DTO.

Cara menggunakan

  1. Tempel class entity ke kolom JPA. Import dan anotasi Lombok boleh tetap ada; sertakan class parent, entity terkait, dan enum agar nilainya terisi.
  2. Class yang tidak direferensikan class lain menjadi root. Ketika entity saling mereferensikan, class public yang dipilih.
  3. Salin hasilnya ke test atau dokumentasi Anda.

Contoh

Input (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;
}
Output (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 dan Patient saling mereferensikan, jadi class public Appointment menjadi root dan Patient.appointments dipotong menjadi array kosong alih-alih berputar tanpa akhir. id dan createdAt dari BaseEntity muncul lebih dulu, dan residentNumber hilang karena @JsonIgnore. LocalDateTime menjadi string ISO tanpa offset, dan enum menampilkan konstanta pertamanya, "BOOKED".

Fitur yang didukung

  • Field static dan transient serta field @JsonIgnore dilewati, begitu pula nama yang tercantum di @JsonIgnoreProperties({"..."}) level class.
  • @JsonProperty("doctor_name") mengganti nama key JSON.
  • Jika class parent (@MappedSuperclass atau extends apa pun) ada di input, field-nya muncul lebih dulu.
  • Default entity seperti private Status status = Status.ACTIVE; atau private int visits = 0; tampil dengan nilai itu, dan computed getter tanpa field pendukung (public int getAge()) muncul sebagai key tambahan, seperti yang akan dikeluarkan Jackson.
  • Output tanggal mengikuti default Spring Boot: LocalDate → 1970-01-01, LocalDateTime → 1970-01-01T00:00:00, java.util.Date → 1970-01-01T00:00:00.000+00:00.
  • Wrapper numerik seperti BigDecimal dan Long menghasilkan 0, UUID menghasilkan UUID berisi nol semua, dan byte[] menghasilkan string base64 "AA==".
  • List/Set menghasilkan array satu elemen, Map<Long, String> menghasilkan objek dengan key yang sesuai ({"0": ""}), dan Optional<T> dibuka menjadi nilai di dalamnya.
  • Asosiasi dua arah (@OneToMany dengan @ManyToOne) dipotong dengan null atau array kosong di titik ia berputar kembali.

Kasus penggunaan

Contoh Spring REST Docs dan Swagger

Buat JSON untuk @Schema(example = ...) atau snippet dokumentasi langsung dari entity, dan tempel lagi setiap kali field berubah agar dokumentasi tetap sinkron.

Mengaudit entity yang diekspos

Jika Anda mengembalikan entity tanpa DTO, periksa apakah field seperti password atau nomor identitas penduduk ikut masuk ke respons. Field di output adalah field yang akan di-serialize Jackson.

Body request MockMvc

Gunakan output sebagai kerangka untuk mockMvc.perform(post("/appointments").content(...)), dengan menghapus id dan timestamp yang dihasilkan sebelum mengisi nilai.

Catatan dan batasan

  • Jackson yang sebenarnya akan rekursi tanpa akhir (StackOverflowError) pada asosiasi dua arah. Jika output tampak terpotong, itu tanda untuk memakai @JsonManagedReference/@JsonBackReference, @JsonIgnore atau DTO.
  • Anotasi @Transient dari JPA secara default tidak diabaikan Jackson, jadi field tersebut tetap ada di output; hanya field dengan keyword Java transient yang dihapus.
  • Asosiasi FetchType.LAZY dalam praktiknya bisa gagal di-serialize sebagai proxy Hibernate; output mengasumsikan semuanya sudah dimuat.
  • Field yang class-nya tidak ada di input muncul sebagai null, dan constraint @Column seperti nullable atau length tidak diterapkan.

FAQ

Apakah tanggal memang seharusnya string dan bukan array seperti [2024,1,1]?

Spring Boot menonaktifkan WRITE_DATES_AS_TIMESTAMPS, jadi LocalDateTime ditulis sebagai string ISO. ObjectMapper yang dibuat sendiri dengan hanya JavaTimeModule yang terdaftar bisa saja menulis array.

Apakah semua field muncul meskipun tanpa Lombok @Getter?

Alat ini bekerja dari deklarasi field. Jackson yang sebenarnya secara default men-serialize lewat getter (atau field public), jadi field private tanpa getter bisa jadi tidak ada di respons sebenarnya.

Bisakah saya menempel class @Document MongoDB juga?

Class itu mengikuti aturan Jackson yang sama, tetapi catatan khusus MongoDB seperti ObjectId dan @Field dibahas di halaman Spring Data MongoDB ke JSON.