Convertissez du JSON en structs Go !

Saisissez du JSON pour le convertir en structs Go avec des balises json ! Compatible avec Go (Golang) struct, json tags.
JSON
Résultat

Convertissez du JSON en structs Go !

Convertit du JSON en définitions de structs Go avec tags encoding/json. Les noms de champs suivent la règle des noms exportés de Go et la liste d'initialismes de golint (ID, URL, API, ...), et les colonnes sont alignées comme si le code était passé par gofmt.

Utile quand il vous faut un type pour faire un json.Unmarshal d'un payload de webhook ou d'une réponse d'API, une struct de corps de requête pour des handlers net/http, Gin ou Echo, ou une struct de config pour une CLI.

Mode d'emploi

  1. Collez le JSON. Avec un tableau de plusieurs lignes, les champs absents de certaines lignes sont détectés et tagués omitempty.
  2. Saisissez le nom de la struct de premier niveau dans Nom de la struct (par défaut Root) ; il reste dans l'URL sous la forme ?name=.
  3. Collez le résultat dans un fichier .go et ajoutez une clause package. Si des champs de temps ont été trouvés, import "time" est inclus.
  4. Utilisez-la ainsi : var ev WebhookEvent; err := json.Unmarshal(body, &ev).

Exemple

Entrée (JSON)
{
  "event_id": "evt_1Pq",
  "type": "invoice.paid",
  "created_at": "2024-05-01T03:15:00Z",
  "amount_cents": 4999,
  "customer": { "id": "cus_9", "email": "kim@example.com" },
  "retry_count": null
}
Sortie (Go)
import "time"

type WebhookEvent struct {
	EventID     string    `json:"event_id"`
	Type        string    `json:"type"`
	CreatedAt   time.Time `json:"created_at"`
	AmountCents int       `json:"amount_cents"`
	Customer    Customer  `json:"customer"`
	RetryCount  any       `json:"retry_count,omitempty"`
}

type Customer struct {
	ID    string `json:"id"`
	Email string `json:"email"`
}

event_id devient EventID selon la règle d'initialismes de golint, et created_at, une chaîne RFC 3339, est inféré comme time.Time, ce qui ajoute import "time". retry_count vaut null, son type est donc inconnu : il devient any avec omitempty.

Fonctionnalités prises en charge

  • Un tag json:"originalKey" sur chaque champ, plus ,omitempty pour les champs absents de certaines lignes ou contenant null.
  • Les types valeur optionnels (int, string, bool, structs, time.Time) deviennent des pointeurs (*int) pour distinguer « absent » de la valeur zéro. Les slices et any acceptent déjà nil et restent sans pointeur.
  • Nombres : int pour les entiers 32 bits, int64 au-delà, float64 dès qu'une décimale apparaît.
  • Les chaînes RFC 3339 comme 2024-05-01T03:15:00Z sont inférées comme time.Time.
  • Les initialismes courants restent en majuscules (user_id → UserID, home_url → HomeURL) ; les clés commençant par un chiffre reçoivent un préfixe Field.
  • Les clés impossibles dans un tag json Go, comme "", sont ignorées et listées dans un commentaire au-dessus de la struct.
  • Un tableau d'objets de premier niveau devient une struct pour l'élément, plus un commentaire indiquant de désérialiser dans []Root.

Cas d'utilisation

Récepteurs de webhooks

Construisez une struct à partir d'un événement d'exemple envoyé par un service de paiement ou d'hébergement Git et décodez-le avec json.NewDecoder(r.Body).Decode(&ev), au lieu d'enchaîner les assertions de type sur map[string]any.

Binding de requêtes dans Gin ou Echo

Générez la struct pour c.ShouldBindJSON(&req) à partir d'un exemple de requête client, puis ajoutez des tags binding:"required" là où il le faut.

CLI qui lisent une config JSON

Transformez config.json en struct une fois pour toutes, et un seul json.Unmarshal après os.ReadFile vous donne toute la config sous forme de valeurs typées.

Remarques et limites

  • time.Time n'est inféré que pour les chaînes RFC 3339 ; des valeurs comme 2024-05-01 03:15:00 ou des timestamps Unix restent string ou int.
  • Par défaut, json.Unmarshal ignore les clés inconnues et compare les clés sans tenir compte de la casse. Utilisez Decoder.DisallowUnknownFields() pour un décodage strict.
  • int fait 64 bits sur les plateformes 64 bits, mais int64 n'est écrit que si une valeur d'exemple dépasse 32 bits. Pour des identifiants susceptibles de grandir, passer vous-même en int64 est plus sûr.
  • Les structs imbriquées sont toutes définies comme des types de premier niveau séparés ; aucune struct anonyme inline n'est utilisée.
  • Les valeurs de type mixte et celles qui ne valent jamais que null deviennent any ; remplacez-les une fois le vrai type connu.

FAQ

Pourquoi les champs optionnels sont-ils des pointeurs comme *int ?

Un champ int simple vaut 0 quand la clé manque, impossible à distinguer d'un vrai 0. Un pointeur vaut nil quand la clé est absente ou null, et avec omitempty la clé est omise lors d'un nouveau marshaling.

Puis-je mettre les noms de champs en minuscules ?

encoding/json ne lit et n'écrit que les champs exportés (avec majuscule) ; les champs en minuscules sont ignorés même avec un tag. En Go, les noms gardent leur majuscule et la clé JSON va dans le tag.

Un champ null comme retry_count est sorti en any.

Avec seulement null dans l'exemple, il n'y a rien pour inférer un type. Ajoutez dans un tableau une autre réponse contenant une vraie valeur et convertissez les deux, ou changez-le à la main en quelque chose comme *int.

Puis-je retransformer une struct Go en JSON d'exemple ?

Oui. Collez la struct dans l'onglet Go struct → JSON en haut ; il lit les tags et produit du JSON d'exemple.