Go-Structs in JSON umwandeln!

Gib Go-Structs ein, um Beispiel-JSON gemäß ihren json-Tags zu erzeugen! Unterstützt Go (Golang) struct, json tags. Praktisch für API-Dokumentation und Test-Request-Bodys (mock request body).
Go struct
Ergebnis
 

Go-Structs in JSON umwandeln!

Füge Go-struct-Definitionen ein und erhalte ein Beispiel-JSON-Dokument, das nach denselben Regeln entsteht, die encoding/json beim Marshaling anwendet: Namen aus json:"..."-Tags, mit - versteckte Felder, die Option ,string, nicht exportierte kleingeschriebene Felder und flach eingebettete Structs.

Praktisch ist das, um aus einem Request-Struct für Gin, Echo oder net/http einen curl-Body zu erzeugen, Beispiele für gRPC-Gateway oder REST-Dokus vorzubereiten und Felder zu finden, deren Tags nicht den erwarteten Key ergeben.

So funktioniert es

  1. Füge type Xxx struct { ... }-Deklarationen ein. Gruppierte type ( ... )-Blöcke und mehrere Structs auf einmal sind kein Problem.
  2. Verwendet ein Feld ein anderes Struct, füge dessen Definition ebenfalls ein. Typen aus externen Paketen, die nicht in der Eingabe stehen (etwa decimal.Decimal), werden zu null.
  3. Optionen gibt es keine: Das erste Struct, auf das kein anderer Typ verweist, wird zum JSON auf oberster Ebene; setze das gewünschte also an den Anfang oder lass nicht zugehörige Structs weg.
  4. Kopiere das Ergebnis in curl -d, einen Postman-Body oder einen Handler-Test auf Basis von httptest.

Beispiel

Eingabe (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
}
Ausgabe (JSON)
{
  "id": "",
  "created_at": "0001-01-01T00:00:00Z",
  "queue": "",
  "attempts": "0",
  "labels": {
    "key": ""
  },
  "timeout_sec": 0,
  "Done": false
}

Das eingebettete Base steuert id und created_at direkt zu Job bei, und Attempts mit dem Tag ,string wird zum String "0" statt zu einer Zahl. Token (Tag -) und das nicht exportierte lastErr fallen weg, während das Feld Done ohne Tag seinen Go-Feldnamen als Key behält. time.Time zeigt den Nullwert von Go, 0001-01-01T00:00:00Z.

Unterstützte Funktionen

  • Verwendet das Tag json:"name" als Key und greift ohne Tag auf den exakten Feldnamen zurück.
  • Überspringt json:"-"-Felder und nicht exportierte kleingeschriebene Felder; json:"-," behält das Feld unter dem wörtlichen Key -.
  • Mit ,string werden numerische und boolesche Felder als Strings wie "0" und "false" verpackt.
  • Eingebettete Structs ohne Tag werden in das Eltern-Struct aufgelöst, wobei äußere Felder bei Namenskonflikten gewinnen; ein eingebettetes Struct mit Tag wird zu einem verschachtelten Objekt unter diesem Namen.
  • Pointer (*int, *Profile) werden mit dem Zieltyp befüllt, und definierte Typen wie type Status string folgen ihrem zugrunde liegenden Typ.
  • []byte wird zu einem (leeren) Base64-String, map[int]T verwendet einen Key "0", time.Duration ist die Nanosekunden-Ganzzahl 0, und interface{}/any sind null.
  • Selbstreferenzierende Structs wie Children []Node enden bei einem leeren Array. Anonyme verschachtelte Struct-Felder werden unterstützt.

Anwendungsfälle

Request-Bodies für Handler-Tests

Füge das Struct ein, das du mit c.ShouldBindJSON(&req) bindest, erzeuge den Body und rufe den Endpoint über httptest.NewRequest oder curl auf. Da die Keys direkt aus den Tags stammen, sind Binding-Fehler unwahrscheinlicher.

Fehler in Tags finden

Gemischte Tags wie json:"user_id" und json:"userId" oder ein vergessenes Tag, durch das ein großgeschriebener Key UserID nach außen dringt, springen in der Ausgabe sofort ins Auge.

Ein Schema mit Clients in anderen Sprachen teilen

Gib Frontend- oder Python-Nutzern das JSON aus deinem Go-Response-Struct; sie können es mit Tools wie JSON → TypeScript oder JSON → Python wieder in Modelle verwandeln.

Hinweise und Einschränkungen

  • omitempty-Felder werden im Beispiel immer angezeigt; beim echten Marshaling fallen sie weg, wenn sie den Nullwert enthalten.
  • Ein nil-Pointer wird als null gemarshalt, das Beispiel zeigt aber den befüllten Fall.
  • Typen mit eigenem MarshalJSON() und der tatsächliche Inhalt von json.RawMessage lassen sich nicht ermitteln und werden nicht abgebildet.
  • Neuere Optionen wie omitzero aus Go 1.24 und das Verhalten von encoding/json/v2 werden nicht berücksichtigt.

Häufige Fragen

Welchen Key bekommt ein Feld ohne Tag?

encoding/json verwendet den exportierten Feldnamen unverändert, aus Done bool wird also "Done". Beim Dekodieren in Go wird zwar case-insensitive abgeglichen, Clients in anderen Sprachen tun das aber nicht, daher sind explizite Tags sicherer.

Warum steht time.Time auf dem Jahr 0001?

Der Nullwert von time.Time in Go ist 0001-01-01 00:00:00 UTC, was nach RFC 3339 als 0001-01-01T00:00:00Z gemarshalt wird. Deshalb unterscheidet es sich von den 1970er-Datumswerten auf den anderen Seiten mit → JSON.

Wann ist json:",string" nützlich?

Vor allem für große int64-IDs, die JavaScript nicht exakt darstellen kann und die deshalb als Strings übertragen werden. Das Beispiel zeigt "0", damit Clients klar ist, dass sie einen String bekommen.

Ich will es umgekehrt: Go-Structs aus JSON.

Nimm die Seite JSON → Go struct. Ihre Ausgabe wieder in diese Seite einzufügen ist ein schneller Weg, um zu prüfen, ob der Hin- und Rückweg die ursprünglichen Keys erhält.