Ubah kelas dokumen MongoDB menjadi JSON!

Masukkan kelas dokumen MongoDB untuk membuat contoh JSON! Mendukung Spring Data MongoDB @Document. Berguna untuk dokumentasi API dan body request uji (mock request body).
Spring Data MongoDB
Hasil
 

Ubah kelas dokumen MongoDB menjadi JSON!

Masukkan class @Document Spring Data MongoDB beserta class dan record embedded-nya, dan alat ini membangun contoh JSON dari apa yang dikembalikan controller saat mengirim dokumen tersebut. Bentuknya mengikuti serialisasi Jackson default Spring Boot, jadi yang dideskripsikan adalah respons API, bukan BSON yang tersimpan di MongoDB.

Alat ini menghemat waktu untuk dokumen MongoDB yang penuh list embedded, field Map dan timestamp Instant, di mana menulis contoh respons secara manual itu melelahkan, dan memperlihatkan perbedaan antara format penyimpanan dan format respons.

Cara menggunakan

  1. Tempel class @Document dan class atau record embedded-nya ke kolom Spring Data MongoDB.
  2. Class dokumen yang tidak direferensikan class lain menjadi root output.
  3. Ganti placeholder id dan tanggal dengan nilai yang realistis sebelum memakai JSON di dokumentasi atau test.

Contoh

Input (Java · Spring Data MongoDB)
@Document(collection = "devices")
public class Device {
    @Id
    private String id;
    private String serial;
    @Field("fw")
    private String firmwareVersion;
    private Map<String, Double> lastReadings;
    private List<Alert> alerts;
    private Instant registeredAt;
}

record Alert(String level, String message, Instant raisedAt) {}
Output (JSON)
{
  "id": "",
  "serial": "",
  "firmwareVersion": "",
  "lastReadings": {
    "key": 0
  },
  "alerts": [
    {
      "level": "",
      "message": "",
      "raisedAt": "1970-01-01T00:00:00Z"
    }
  ],
  "registeredAt": "1970-01-01T00:00:00Z"
}

Alert di List<Alert> adalah record, jadi komponennya level, message dan raisedAt menjadi field. Map<String, Double> menjadi {"key": 0}, dan Instant menjadi string UTC yang diakhiri Z. @Field("fw") hanya mengganti nama field yang tersimpan di MongoDB, jadi key JSON tetap firmwareVersion.

Fitur yang didukung

  • Komponen record Java, seperti pada record Alert(String level, ...), dibaca sebagai field.
  • List dan Set menjadi array satu elemen; Map<String, T> menjadi {"key": value}.
  • Instant, ZonedDateTime dan OffsetDateTime menghasilkan 1970-01-01T00:00:00Z, sedangkan LocalDateTime menghasilkan string tanpa offset.
  • Field bertipe ObjectId mendapat string ObjectId hex contoh.
  • Class yang dihubungkan dengan @DBRef menjadi objek bersarang jika ada di input.
  • @JsonIgnore, @JsonProperty, @JsonIgnoreProperties dan field yang diwarisi mengikuti aturan yang sama dengan halaman JPA.

Kasus penggunaan

Respons dengan banyak dokumen embedded

Struktur yang dikemas MongoDB ke dalam satu dokumen, seperti list ulasan, map opsi, dan array riwayat, menghasilkan contoh respons yang panjang. Tempel class-nya dan setiap level bersarang dituliskan untuk Anda.

Membandingkan bentuk tersimpan dan yang dikembalikan

Nama pendek lewat @Field atau field yang dipetakan ke _id membuat key database berbeda dari key API. Output menampilkan sisi API, jadi Anda bisa menyandingkan keduanya.

Catatan dan batasan

  • Anotasi pemetaan seperti @Field("..."), @Indexed dan @TextIndexed tidak mengubah key JSON dan tidak tercermin.
  • @Id String id disimpan sebagai _id tetapi keluar dari Jackson sebagai id, dan itulah yang ditampilkan output.
  • Jackson default Spring Boot menulis org.bson.types.ObjectId sebagai objek berisi timestamp dan date, bukan string hex. Untuk mengirim bentuk string seperti yang ditampilkan di sini, daftarkan ToStringSerializer atau gunakan id bertipe String.
  • Class yang tidak ada di input, termasuk tipe Spring Data seperti GeoJsonPoint, menjadi null.

FAQ

Sebaiknya @Id saya bertipe ObjectId atau String?

Dengan String, Spring Data mengonversinya menjadi ObjectId saat menyimpan dan API mengembalikan string hex yang bersih. Mempertahankan tipe ObjectId berarti Anda butuh konfigurasi Jackson tambahan untuk respons.

Apakah field @DBRef benar-benar dikembalikan sebagai objek bersarang?

@DBRef me-resolve dokumen yang direferensikan saat membaca (pada akses pertama jika lazy), jadi respons berisi objek bersarang. Referensi manual yang hanya menyimpan id ObjectId atau String hanya mengembalikan id-nya.

Seperti apa bentuk field Map<String, Object> yang bebas?

Tipe nilainya tidak diketahui, jadi menjadi {"key": null}. Ganti dengan jenis nilai yang benar-benar Anda simpan sebelum memasukkannya ke dokumentasi.