Go struct definitions پیسٹ کریں اور انہی قواعد سے بنا مثالی JSON document حاصل کریں جو encoding/json، marshal کرتے وقت لاگو کرتا ہے: json:"..." tag نام، - سے چھپائے گئے فیلڈز، ,string option، unexported چھوٹے حروف والے فیلڈز اور ہموار کیے گئے embedded structs۔
یہ Gin، Echo یا net/http کے request struct سے curl body بنانے، gRPC-Gateway یا REST docs کے لیے نمونے تیار کرنے، اور ایسے فیلڈز پکڑنے میں کام آتا ہے جن کے tags متوقع key نہیں بناتے۔
type Xxx struct { ... } declarations پیسٹ کریں۔ گروپ کیے گئے type ( ... ) بلاکس اور ایک ساتھ کئی structs ٹھیک ہیں۔decimal.Decimal) بنتی ہیں null۔curl -d، Postman body یا httptest پر مبنی handler ٹیسٹ میں کاپی کریں۔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
}{
"id": "",
"created_at": "0001-01-01T00:00:00Z",
"queue": "",
"attempts": "0",
"labels": {
"key": ""
},
"timeout_sec": 0,
"Done": false
}embedded Base، id اور created_at سیدھا Job کو دیتا ہے، اور ,string tag والا Attempts نمبر کے بجائے string "0" بنتا ہے۔ Token (tag -) اور unexported lastErr ہٹا دیے جاتے ہیں، جبکہ بغیر tag والا Done اپنا Go فیلڈ نام ہی key کے طور پر رکھتا ہے۔ time.Time، Go کی zero value 0001-01-01T00:00:00Z دکھاتا ہے۔
json:"name" tag کو key کے طور پر استعمال کرتا ہے، اور tag نہ ہو تو بالکل فیلڈ کا نام۔json:"-" فیلڈز اور unexported چھوٹے حروف والے فیلڈز چھوڑ دیتا ہے؛ json:"-," فیلڈ کو لفظی key - کے تحت رکھتا ہے۔,string کے ساتھ عددی اور boolean فیلڈز "0" اور "false" جیسی strings میں لپیٹے جاتے ہیں۔*int، *Profile) جس type کی طرف اشارہ کریں اسی سے بھرے جاتے ہیں، اور type Status string جیسی defined types اپنی بنیادی type پر چلتی ہیں۔[]byte بنتا ہے Base64 (خالی) string، map[int]T میں "0" key استعمال ہوتی ہے، time.Duration نینو سیکنڈ والا integer 0 ہے، اور interface{}/any بنتے ہیں null۔Children []Node جیسے خود کا حوالہ دینے والے structs خالی array پر رک جاتے ہیں۔ anonymous nested struct فیلڈز سپورٹ ہیں۔c.ShouldBindJSON(&req) سے bind ہونے والا struct پیسٹ کریں، body بنائیں، اور endpoint کو httptest.NewRequest یا curl سے کال کریں۔ چونکہ keys سیدھی tags سے آتی ہیں، binding میں عدم مطابقت کا امکان کم ہو جاتا ہے۔
ملے جلے json:"user_id" اور json:"userId" tags، یا بھولا ہوا tag جس سے بڑے حروف والی UserID key باہر آ جائے، آؤٹ پٹ میں ایک نظر میں واضح ہو جاتے ہیں۔
فرنٹ اینڈ یا Python استعمال کنندگان کو اپنے Go response struct کا JSON دیں؛ وہ JSON → TypeScript یا JSON → Python جیسے ٹولز سے اسے واپس ماڈلز میں بدل سکتے ہیں۔
omitempty فیلڈز نمونے میں ہمیشہ دکھائے جاتے ہیں؛ اصل marshaling میں zero value ہونے پر وہ ہٹ جاتے ہیں۔nil pointer، null کے طور پر marshal ہوتا ہے، لیکن نمونہ بھری ہوئی صورت دکھاتا ہے۔MarshalJSON() والی types اور json.RawMessage کا اصل مواد معلوم نہیں ہو سکتا اور ان کا اثر نہیں دکھایا جاتا۔omitzero اور encoding/json/v2 کا رویہ جیسے نئے options شامل نہیں۔encoding/json بالکل exported فیلڈ کا نام استعمال کرتا ہے، اس لیے Done bool بنتا ہے "Done"۔ Go میں decoding حروف کے case کی پروا کیے بغیر ملاتی ہے، لیکن دوسری زبانوں کے clients ایسا نہیں کرتے، اس لیے واضح tags زیادہ محفوظ ہیں۔
time.Time سال 0001 پر کیوں ہے؟Go کا zero time.Time، 0001-01-01 00:00:00 UTC ہے، جو RFC 3339 میں 0001-01-01T00:00:00Z کی صورت میں marshal ہوتا ہے۔ اسی لیے یہ دوسرے → JSON صفحات کی 1970 والی تاریخوں سے مختلف ہے۔
json:",string" کب مفید ہے؟زیادہ تر بڑی int64 IDs کے لیے جنہیں JavaScript ٹھیک ٹھیک ظاہر نہیں کر سکتی، اس لیے وہ strings کی صورت میں بھیجی جاتی ہیں۔ نمونہ "0" دکھاتا ہے، جس سے clients کو واضح ہو جاتا ہے کہ انہیں string ملے گی۔
JSON → Go struct صفحہ استعمال کریں۔ اس کا آؤٹ پٹ واپس اس صفحے کو دینا یہ جانچنے کا تیز طریقہ ہے کہ آنا جانا اصل keys برقرار رکھتا ہے۔