Tukar struct Go kepada JSON!

Masukkan struct Go untuk menjana contoh JSON mengikut tag json! Menyokong Go (Golang) struct, json tags. Berguna untuk dokumentasi API dan badan permintaan ujian (mock request body).
Go struct
Hasil
 

Tukar struct Go kepada JSON!

Tampal definisi struct Go dan dapatkan contoh dokumen JSON yang dibina dengan peraturan yang sama digunakan encoding/json semasa marshal: nama tag json:"...", field yang disembunyikan dengan -, opsyen ,string, field huruf kecil yang tidak dieksport dan embedded struct yang diratakan.

Ia berguna untuk menghasilkan body curl daripada struct request Gin, Echo atau net/http, menyediakan sampel untuk dokumentasi gRPC-Gateway atau REST, dan mengesan field yang tag-nya tidak menghasilkan kunci yang anda jangkakan.

Cara menggunakan

  1. Tampal deklarasi type Xxx struct { ... }. Blok berkumpulan type ( ... ) dan beberapa struct sekaligus tidak menjadi masalah.
  2. Jika sesuatu field menggunakan struct lain, sertakan juga definisinya. Jenis daripada package luar yang tiada dalam input (seperti decimal.Decimal) menjadi null.
  3. Tiada opsyen: struct pertama yang tidak dirujuk oleh jenis lain menjadi JSON peringkat atas, jadi letakkan struct yang anda mahu di hadapan atau keluarkan struct yang tidak berkaitan.
  4. Salin hasilnya ke dalam curl -d, body Postman atau ujian handler berasaskan httptest.

Contoh

Input (Go struct)
type Base struct {
	ID        string    `json:"id"`
	CreatedAt time.Time `json:"created_at"`
}

type Job struct {
	Base
	Queue      string            `json:"queue"`
	Attempts   int               `json:"attempts,string"`
	Labels     map[string]string `json:"labels,omitempty"`
	TimeoutSec *int              `json:"timeout_sec,omitempty"`
	Token      string            `json:"-"`
	Done       bool
	lastErr    error
}
Output (JSON)
{
  "id": "",
  "created_at": "0001-01-01T00:00:00Z",
  "queue": "",
  "attempts": "0",
  "labels": {
    "key": ""
  },
  "timeout_sec": 0,
  "Done": false
}

Embedded Base menyumbang id dan created_at terus kepada Job, dan Attempts yang bertag ,string menjadi string "0", bukan nombor. Token (tag -) dan lastErr yang tidak dieksport digugurkan, manakala Done yang tiada tag mengekalkan nama field Go sebagai kunci. time.Time memaparkan zero value Go, iaitu 0001-01-01T00:00:00Z.

Ciri yang disokong

  • Menggunakan tag json:"name" sebagai kunci, dan kembali kepada nama field yang tepat jika tiada tag.
  • Melangkau field json:"-" dan field huruf kecil yang tidak dieksport; json:"-," mengekalkan field di bawah kunci literal -.
  • Dengan ,string, field nombor dan boolean dibalut sebagai string seperti "0" dan "false".
  • Embedded struct tanpa tag diratakan ke dalam induknya, dengan field luar diutamakan apabila nama bertembung; embedded struct yang bertag menjadi objek bersarang di bawah nama tersebut.
  • Pointer (*int, *Profile) diisi dengan jenis yang ditunjuknya, dan jenis yang ditakrifkan seperti type Status string mengikut jenis asasnya.
  • []byte menjadi string Base64 (kosong), map[int]T menggunakan kunci "0", time.Duration ialah integer nanosaat 0, dan interface{}/any ialah null.
  • Struct yang merujuk dirinya sendiri seperti Children []Node berhenti pada array kosong. Field anonymous nested struct disokong.

Kes penggunaan

Body request untuk ujian handler

Tampal struct yang anda bind dengan c.ShouldBindJSON(&req), jana body, dan panggil endpoint melalui httptest.NewRequest atau curl. Oleh sebab kunci diambil terus daripada tag, ketidakpadanan binding kurang berkemungkinan berlaku.

Mencari kesilapan tag

Tag json:"user_id" dan json:"userId" yang bercampur, atau tag yang terlupa sehingga kunci huruf besar UserID terlepas keluar, jelas kelihatan dalam output.

Berkongsi skema dengan klien dalam bahasa lain

Berikan JSON daripada struct response Go anda kepada pengguna frontend atau Python; mereka boleh menukarnya semula menjadi model dengan alat seperti JSON → TypeScript atau JSON → Python.

Nota dan had

  • Field omitempty sentiasa dipaparkan dalam sampel; marshal sebenar akan menggugurkannya apabila ia memegang zero value.
  • Pointer nil di-marshal sebagai null, tetapi sampel memaparkan keadaan yang berisi.
  • Jenis dengan MarshalJSON() tersuai dan kandungan sebenar json.RawMessage tidak dapat diketahui dan tidak dicerminkan.
  • Opsyen yang lebih baharu seperti omitzero dalam Go 1.24 dan tingkah laku encoding/json/v2 tidak diliputi.

Soalan lazim

Apakah kunci bagi field tanpa tag?

encoding/json menggunakan nama field yang dieksport sebagaimana adanya, jadi Done bool menjadi "Done". Decoding dalam Go memadankan tanpa mengira huruf besar kecil, tetapi klien dalam bahasa lain tidak, jadi tag eksplisit lebih selamat.

Kenapa time.Time ditetapkan kepada tahun 0001?

Zero value time.Time dalam Go ialah 0001-01-01 00:00:00 UTC, yang di-marshal dalam RFC 3339 sebagai 0001-01-01T00:00:00Z. Itulah sebabnya ia berbeza daripada tarikh 1970 di halaman → JSON yang lain.

Bilakah json:",string" berguna?

Kebanyakannya untuk ID int64 yang besar yang tidak dapat diwakili dengan tepat oleh JavaScript, jadi ia dihantar sebagai string. Sampel memaparkan "0", menjelaskan kepada klien bahawa mereka akan menerima string.

Saya mahu sebaliknya: struct Go daripada JSON.

Gunakan halaman JSON → Go struct. Memasukkan semula outputnya ke halaman ini ialah cara pantas untuk memastikan perjalanan pergi balik mengekalkan kunci asal.