Converta JSON em structs Go!

Insira JSON para convertê-lo em structs Go com tags json! Compatível com Go (Golang) struct, json tags.
JSON
Resultado

Converta JSON em structs Go!

Converte JSON em definições de struct Go com tags do encoding/json. Os nomes dos campos seguem a regra de nomes exportados do Go e a lista de initialisms do golint (ID, URL, API, ...), e as colunas ficam alinhadas como se o código tivesse passado pelo gofmt.

É útil quando você precisa de um tipo para fazer json.Unmarshal de um payload de webhook ou resposta de API, de um struct de request body para handlers net/http, Gin ou Echo, ou de um struct de configuração para uma CLI.

Como usar

  1. Cole o JSON. Com um array de várias linhas, os campos que faltam em algumas delas são detectados e marcados com omitempty.
  2. Informe o nome do struct de nível mais alto em Nome do struct (padrão Root); ele fica na URL como ?name=.
  3. Cole o resultado num arquivo .go e adicione a cláusula package. Se foram encontrados campos de tempo, o import "time" vem incluído.
  4. Use como var ev WebhookEvent; err := json.Unmarshal(body, &ev).

Exemplo

Entrada (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
}
Saída (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 vira EventID pela regra de initialisms do golint, e created_at, uma string RFC 3339, é inferido como time.Time, o que adiciona import "time". retry_count é null, então o tipo é desconhecido: vira any com omitempty.

Recursos suportados

  • Uma tag json:"originalKey" em todo campo, mais ,omitempty para campos que faltam em algumas linhas ou contêm null.
  • Value types opcionais (int, string, bool, structs, time.Time) viram ponteiros (*int) para que "ausente" seja diferente do zero value. Slices e any já aceitam nil e continuam sem ponteiro.
  • Números: int para inteiros de 32 bits, int64 acima disso, float64 quando aparecem decimais.
  • Strings RFC 3339 como 2024-05-01T03:15:00Z são inferidas como time.Time.
  • Initialisms comuns ficam em maiúsculas (user_id → UserID, home_url → HomeURL); chaves que começam com dígito ganham o prefixo Field.
  • Chaves que não podem aparecer numa json tag do Go, como "", são puladas e listadas num comentário acima do struct.
  • Um array de objetos no nível mais alto vira um struct para o elemento mais um comentário para fazer unmarshal em []Root.

Casos de uso

Receptores de webhook

Monte um struct a partir de um evento de exemplo enviado por um serviço de pagamento ou de hospedagem Git e decodifique com json.NewDecoder(r.Body).Decode(&ev), em vez de repetir type assertions em map[string]any.

Binding de request no Gin ou Echo

Gere o struct para c.ShouldBindJSON(&req) a partir de um exemplo de request do client e depois adicione tags binding:"required" onde precisar.

CLIs que leem config em JSON

Transforme o config.json num struct uma vez, e um único json.Unmarshal depois do os.ReadFile entrega toda a configuração com valores tipados.

Observações e limitações

  • time.Time só é inferido para strings RFC 3339; valores como 2024-05-01 03:15:00 ou Unix timestamps continuam string ou int.
  • O json.Unmarshal ignora chaves desconhecidas e compara as chaves sem diferenciar maiúsculas por padrão. Use Decoder.DisallowUnknownFields() se quiser um decode estrito.
  • int tem 64 bits em plataformas de 64 bits, mas int64 só é escrito quando um valor de exemplo passa de 32 bits. Para IDs que podem crescer, trocar para int64 você mesmo é mais seguro.
  • Structs aninhados são todos definidos como tipos separados de nível mais alto; não são usados structs anônimos inline.
  • Valores de tipo misto e valores que só aparecem como null viram any; troque quando souber o tipo real.

Perguntas frequentes

Por que os campos opcionais são ponteiros como *int?

Um campo int simples fica 0 quando a chave falta, sem como diferenciar de um 0 real. Um ponteiro é nil quando a chave está ausente ou é null, e junto com o omitempty a chave fica de fora quando você faz marshal de novo.

Posso deixar os nomes dos campos em minúscula?

O encoding/json só lê e escreve campos exportados (com inicial maiúscula); campos em minúscula são ignorados mesmo com tag. No Go, os nomes ficam com inicial maiúscula e a chave JSON vai na tag.

Um campo null como retry_count saiu como any.

Com só null no exemplo, não há de onde inferir um tipo. Junte num array outra resposta com um valor real e converta as duas, ou troque na mão para algo como *int.

Dá para transformar um struct Go de volta em JSON de exemplo?

Sim. Cole o struct na aba Go struct → JSON no topo; ela lê as tags e gera um JSON de exemplo.