แปลง Go struct เป็น JSON!

ป้อน Go struct เพื่อสร้าง JSON ตัวอย่างตามแท็ก json! รองรับ Go (Golang) struct, json tags เหมาะสำหรับเอกสาร API และ request body สำหรับทดสอบ (mock request body)
Go struct
ผลลัพธ์
 

แปลง Go struct เป็น JSON!

วางนิยาม struct ของ Go แล้วจะได้ตัวอย่าง JSON ที่สร้างตามกฎเดียวกับที่ encoding/json ใช้ตอน marshal ได้แก่ ชื่อจากแท็ก json:"..." ฟิลด์ที่ซ่อนด้วย - ตัวเลือก ,string ฟิลด์ตัวพิมพ์เล็กที่ไม่ได้ export และ embedded struct ที่ถูกแผ่ออก

เหมาะสำหรับสร้าง body ของ curl จาก request struct ของ Gin, Echo หรือ net/http เตรียมตัวอย่างให้ gRPC-Gateway หรือเอกสาร REST และหาฟิลด์ที่แท็กไม่ได้ให้คีย์ตามที่คาดไว้

วิธีใช้

  1. วางการประกาศ type Xxx struct { ... } จะเป็นบล็อก type ( ... ) แบบจัดกลุ่มหรือหลาย struct พร้อมกันก็ได้
  2. ถ้าฟิลด์ใช้ struct อื่น ให้ใส่นิยามนั้นมาด้วย ไทป์จากแพ็กเกจภายนอกที่ไม่อยู่ในอินพุต (เช่น decimal.Decimal) จะเป็น null
  3. ไม่มีตัวเลือกให้ตั้ง struct แรกที่ไม่ถูกไทป์อื่นอ้างถึงจะเป็น JSON ระดับบนสุด ดังนั้นให้วาง struct ที่ต้องการไว้ก่อน หรือตัด struct ที่ไม่เกี่ยวข้องออก
  4. คัดลอกผลลัพธ์ไปใช้ใน curl -d, body ของ Postman หรือเทสต์ handler ที่ใช้ httptest

ตัวอย่าง

อินพุต (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
}
เอาต์พุต (JSON)
{
  "id": "",
  "created_at": "0001-01-01T00:00:00Z",
  "queue": "",
  "attempts": "0",
  "labels": {
    "key": ""
  },
  "timeout_sec": 0,
  "Done": false
}

Base ที่ embed ไว้ส่ง id และ created_at เข้าไปใน Job โดยตรง และ Attempts ที่ติดแท็ก ,string กลายเป็นสตริง "0" แทนตัวเลข Token (แท็ก -) และ lastErr ที่ไม่ได้ export ถูกตัดออก ส่วน Done ที่ไม่มีแท็กใช้ชื่อฟิลด์ Go เป็นคีย์ time.Time แสดงค่าศูนย์ของ Go คือ 0001-01-01T00:00:00Z

ฟีเจอร์ที่รองรับ

  • ใช้แท็ก json:"name" เป็นคีย์ ถ้าไม่มีแท็กจะใช้ชื่อฟิลด์ตรงตามที่เขียน
  • ข้ามฟิลด์ json:"-" และฟิลด์ตัวพิมพ์เล็กที่ไม่ได้ export ส่วน json:"-," จะเก็บฟิลด์ไว้ใต้คีย์ - ตามตัวอักษร
  • เมื่อมี ,string ฟิลด์ตัวเลขและบูลีนจะถูกห่อเป็นสตริงอย่าง "0" และ "false"
  • embedded struct ที่ไม่มีแท็กถูกแผ่เข้าไปใน parent โดยฟิลด์ด้านนอกชนะเมื่อชื่อชนกัน ส่วน embedded struct ที่มีแท็กจะกลายเป็นออบเจ็กต์ซ้อนใต้ชื่อนั้น
  • พอยน์เตอร์ (*int, *Profile) ถูกเติมด้วยไทป์ที่ชี้ไป และ defined type อย่าง type Status string ใช้ตาม underlying type
  • []byte เป็นสตริง Base64 (ว่าง) map[int]T ใช้คีย์ "0" time.Duration เป็นจำนวนเต็มนาโนวินาที 0 และ interface{}/any เป็น null
  • struct ที่อ้างถึงตัวเองอย่าง Children []Node จะหยุดที่อาร์เรย์ว่าง และรองรับฟิลด์ที่เป็น anonymous struct ซ้อนอยู่

กรณีการใช้งาน

request body สำหรับเทสต์ handler

วาง struct ที่คุณ bind ด้วย c.ShouldBindJSON(&req) สร้าง body แล้วเรียก endpoint ผ่าน httptest.NewRequest หรือ curl เพราะคีย์มาจากแท็กโดยตรง โอกาสที่ binding จะไม่ตรงจึงน้อยลง

หาแท็กที่เขียนผิด

แท็ก json:"user_id" กับ json:"userId" ที่ปนกัน หรือการลืมใส่แท็กจนคีย์ UserID ตัวพิมพ์ใหญ่หลุดออกไป จะเห็นได้ทันทีในผลลัพธ์

แชร์ schema กับไคลเอนต์ที่ใช้ภาษาอื่น

ส่ง JSON จาก response struct ของ Go ให้ฝั่ง frontend หรือ Python แล้วพวกเขาจะแปลงกลับเป็นโมเดลได้ด้วยเครื่องมืออย่าง JSON → TypeScript หรือ JSON → Python

ข้อควรระวังและข้อจำกัด

  • ฟิลด์ omitempty จะแสดงในตัวอย่างเสมอ แต่การ marshal จริงจะตัดออกเมื่อมีค่าเป็นศูนย์
  • พอยน์เตอร์ที่เป็น nil จะ marshal เป็น null แต่ตัวอย่างจะแสดงกรณีที่มีค่า
  • ไทป์ที่มี MarshalJSON() แบบกำหนดเอง และเนื้อหาจริงของ json.RawMessage ไม่สามารถรู้ได้ จึงไม่ถูกสะท้อนในผลลัพธ์
  • ตัวเลือกใหม่ ๆ อย่าง omitzero ของ Go 1.24 และพฤติกรรมของ encoding/json/v2 ยังไม่รองรับ

คำถามที่พบบ่อย

ฟิลด์ที่ไม่มีแท็กจะได้คีย์อะไร?

encoding/json ใช้ชื่อฟิลด์ที่ export ตรงตามตัว ดังนั้น Done bool จะเป็น "Done" การ decode ใน Go จับคู่แบบไม่สนตัวพิมพ์ แต่ไคลเอนต์ภาษาอื่นไม่ได้ทำแบบนั้น การใส่แท็กให้ชัดเจนจึงปลอดภัยกว่า

ทำไม time.Time ถึงเป็นปี 0001?

ค่าศูนย์ของ time.Time ใน Go คือ 0001-01-01 00:00:00 UTC ซึ่ง marshal ในรูปแบบ RFC 3339 เป็น 0001-01-01T00:00:00Z นี่คือเหตุผลที่ต่างจากวันที่ปี 1970 ในหน้า → JSON อื่น ๆ

json:",string" มีประโยชน์ตอนไหน?

ส่วนใหญ่ใช้กับ ID แบบ int64 ขนาดใหญ่ที่ JavaScript แทนค่าได้ไม่แม่นยำ จึงส่งเป็นสตริงแทน ตัวอย่างแสดง "0" ทำให้ไคลเอนต์รู้ชัดว่าจะได้รับสตริง

อยากได้แบบกลับกัน คือสร้าง Go struct จาก JSON

ใช้หน้า JSON → Go struct การนำผลลัพธ์จากหน้านั้นกลับมาใส่หน้านี้เป็นวิธีที่เร็วในการเช็กว่าการแปลงไป-กลับยังคงคีย์เดิมไว้