Create go type representation from json

Overview

json2go Build Go Report Card GoDoc Coverage Mentioned in Awesome Go

Package json2go provides utilities for creating go type representation from json inputs.

Json2go can be used in various ways:

Why another conversion tool?

There are few tools for converting json to go types available already. But all of which I tried worked correctly with only basic documents.

The goal of this project is to create types, that are guaranteed to properly unmarshal input data. There are multiple test cases that check marshaling/unmarshaling both ways to ensure generated type is accurate.

Here's the micro acid test if you want to check this or other conversion tools:

[{"date":"2020-10-03T15:04:05Z","text":"txt1","doc":{"x":"x"}},{"date":"2020-10-03T15:05:02Z","_doc":false,"arr":[[1,null,1.23]]},{"bool":true,"doc":{"y":123}}]

And correct output with some comments:

type Document []struct {
        Arr  [][]*float64 `json:"arr,omitempty"` // Should be doubly nested array; should be a pointer type because there's null in values.
        Bool *bool        `json:"bool,omitempty"` // Shouldn't be `bool` because when key is missing you'll get false information.
        Date *time.Time   `json:"date,omitempty"` // Could be also `string` or `*string`.
        Doc  *struct {
                X *string `json:"x,omitempty"` // Should be pointer, because key is not present in all documents.
                Y *int    `json:"y,omitempty"` // Should be pointer, because key is not present in all documents.
        } `json:"doc,omitempty"` // Should be pointer, because key is not present in all documents in array.
        Doc2 *bool   `json:"_doc,omitempty"` // Attribute for "_doc" key (other that for "doc"!). Type - the same as `Bool` attribute.
        Text *string `json:"text,omitempty"` // Could be also `string`.
}

CLI Installation

go get github.com/m-zajac/json2go/...

Usage

Json2go can be used as cli tool or as package.

CLI tools can be used directly to create go type from stdin data (see examples).

Package provides Parser, which can consume multiple jsons and outputs go type fitting all inputs (see examples and documentation). Example usage: read documents from document-oriented database and feed them too parser for go struct.

CLI usage examples

echo '{"x":1,"y":2}' | json2go

curl -s https://api.punkapi.com/v2/beers?page=1&per_page=5 | json2go

Check this one :)


cat data.json | json2go

Package usage examples

inputs := []string{
	`{"x": 123, "y": "test", "z": false}`,
	`{"a": 123, "x": 12.3, "y": true}`,
}

parser := json2go.NewJSONParser("Document")
for _, in := range inputs {
	parser.FeedBytes([]byte(in))
}

res := parser.String()
fmt.Println(res)

Example outputs

{
    "line": {
        "point1": {
            "x": 12.1,
            "y": 2
        },
        "point2": {
            "x": 12.1,
            "y": 2
        }
    }
}
type Document struct {
        Line struct {
                Point1 Point `json:"point1"`
                Point2 Point `json:"point2"`
        } `json:"line"`
}
type Point struct {
        X float64 `json:"x"`
        Y int     `json:"y"`
}

[
    {
        "name": "water",
        "type": "liquid",
        "boiling_point": {
            "units": "C",
            "value": 100
        }
    },
    {
        "name": "oxygen",
        "type": "gas",
        "density": {
            "units": "g/L",
            "value": 1.429
        }
    },
    {
        "name": "carbon monoxide",
        "type": "gas",
        "dangerous": true,
        "boiling_point": {
            "units": "C",
            "value": -191.5
        },
        "density": {
            "units": "kg/m3",
            "value": 789
        }
    }
]
type Document []struct {
        BoilingPoint *UnitsValue `json:"boiling_point,omitempty"`
        Dangerous    *bool       `json:"dangerous,omitempty"`
        Density      *UnitsValue `json:"density,omitempty"`
        Name         string      `json:"name"`
        Type         string      `json:"type"`
}
type UnitsValue struct {
        Units string  `json:"units"`
        Value float64 `json:"value"`
}

Contribution

I'd love your input! Especially reporting bugs and proposing new features.

Comments
  • feature request: add time.Time and few other changes

    feature request: add time.Time and few other changes

    1. Please see if it is possible to support time.Time for dates.
    2. Option to not sort golang struct alphabatically basically preserving the json appearance of fields in golang struct. Excellent tool btw
    opened by pdemacs 5
  • Output to type Name struct

    Output to type Name struct

    How do we use a *JSONParser as a type struct without copying and pasting the .string ??? I.e. define a struct with the output of parser.FeedValue() without having to copy and pee.

    opened by iCPU 2
  • Incorrect struct type

    Incorrect struct type

    The struct type is incorrectly created for the newly created datatype. The newly datatype is created as an array struct when one of the extractable substructure is an array at one place and non-array in other.

    Input {"starttime":"2021-03-10T08:04:05Z", "endtime":"2021-03-10T15:04:05Z", "details": [{"state":"working", "duration":25 }, {"state":"idle", "duration":15 }, {"state":"working", "duration":20 }] }, {"starttime":"2021-03-10T08:04:05Z", "endtime":"2021-03-10T15:04:05Z", "totalwork": {"state":"working", "duration":25 } },

    Ouput Expected type Document struct { Details []DurationState json:"details,omitempty" Endtime time.Time json:"endtime" Starttime time.Time json:"starttime" Totalwork *DurationState json:"totalwork,omitempty" } type DurationState struct { Duration int json:"duration" State string json:"state" }

    Actual type Document struct { Details []DurationState json:"details,omitempty" Endtime time.Time json:"endtime" Starttime time.Time json:"starttime" Totalwork *DurationState json:"totalwork,omitempty" } type DurationState []struct { Duration int json:"duration" State string json:"state" }

    Here the DurationState is created as an array struct when it should just be a struct.

    I am willing to provide a PR for this issue with fix. Please let me know.

    bug 
    opened by Codinee 2
  • Nested arrays parsing error

    Nested arrays parsing error

    package main
    
    import (
    	"fmt"
    
    	"github.com/m-zajac/json2go"
    )
    
    func main() {
    	arrSInp := []string{
    		`[[{"a": 2, "b": 3}, {"a": 4, "b": 5}]]`,
    		`[[{"a":6, "b": 7}, {"a": 8, "b": 9}]]`,
    	}
      
    	parser := json2go.NewJSONParser("X")
    	for _, in := range arrSInp {
    		parser.FeedBytes([]byte(in))
    	}
    	fmt.Println(parser.String())
    }
    

    want:

      type X [][]struct {
              A       int     `json:"a"`
              B       int     `json:"b"`
      }
    

    got:

      type X []struct {
              A       int     `json:"a"`
              B       int     `json:"b"`
      }
    
    opened by m-zajac 1
  • Null values in arrays always result in []interface{} type

    Null values in arrays always result in []interface{} type

    This json: [1, null, 2, 3] generates type []interface{}. But it should produce type similar to what is generated for this data: [{"x":1}, {"x":null}, {"x":2}, {"x":3}]. Valid result should be: []*int

    opened by m-zajac 0
  • Invalid output for some inputs

    Invalid output for some inputs

    Examples to check:

    [1, 2, 3.1]
    
    {
    "_id":123,
    "id":123
    }
    
    {
    "i":"sda",
    "i":1
    }
    
    {
      "test\"`\n}\n \nfunc init() {\n panic(\"\")\nvar test = `\"": 123
    }
    
    opened by m-zajac 0
convert JSON of a specific format to a type structure(Typescript type or more)

json2type convert JSON of a specific format to a type structure(Typescript type or more) Quick Start CLI Install use go tool install go install github

Kim 3 Mar 28, 2022
Small utility to create JSON objects

gjo Small utility to create JSON objects. This was inspired by jpmens/jo. Support OS Mac Linux Windows Requirements Go 1.1.14~ Git Installtion Build $

skanehira 110 Jul 7, 2022
Fluent API to make it easier to create Json objects.

Jsongo Fluent API to make it easier to create Json objects. Install go get github.com/ricardolonga/jsongo Usage To create this: { "name":"Ricar

Ricardo Longa 104 Sep 2, 2022
Get JSON values quickly - JSON parser for Go

get json values quickly GJSON is a Go package that provides a fast and simple way to get values from a json document. It has features such as one line

Josh Baker 11.1k Sep 22, 2022
JSON diff library for Go based on RFC6902 (JSON Patch)

jsondiff jsondiff is a Go package for computing the diff between two JSON documents as a series of RFC6902 (JSON Patch) operations, which is particula

William Poussier 201 Sep 25, 2022
Fast JSON encoder/decoder compatible with encoding/json for Go

Fast JSON encoder/decoder compatible with encoding/json for Go

Masaaki Goshima 1.8k Sep 19, 2022
Package json implements encoding and decoding of JSON as defined in RFC 7159

Package json implements encoding and decoding of JSON as defined in RFC 7159. The mapping between JSON and Go values is described in the documentation for the Marshal and Unmarshal functions

High Performance, Kubernetes Native Object Storage 2 Jun 26, 2022
Json-go - CLI to convert JSON to go and vice versa

Json To Go Struct CLI Install Go version 1.17 go install github.com/samit22/js

Samit Ghimire 7 Jul 29, 2022
JSON Spanner - A Go package that provides a fast and simple way to filter or transform a json document

JSON SPANNER JSON Spanner is a Go package that provides a fast and simple way to

null 6 Sep 14, 2022
Abstract JSON for golang with JSONPath support

Abstract JSON Abstract JSON is a small golang package provides a parser for JSON with support of JSONPath, in case when you are not sure in its struct

Stepan Pyzhov 127 Sep 21, 2022
Fast JSON parser and validator for Go. No custom structs, no code generation, no reflection

fastjson - fast JSON parser and validator for Go Features Fast. As usual, up to 15x faster than the standard encoding/json. See benchmarks. Parses arb

Aliaksandr Valialkin 1.7k Sep 27, 2022
A Go package for handling common HTTP JSON responses.

go-respond A Go package for handling common HTTP JSON responses. Installation go get github.com/nicklaw5/go-respond Usage The goal of go-respond is to

Nick Law 50 Sep 26, 2022
JSON query in Golang

gojq JSON query in Golang. Install go get -u github.com/elgs/gojq This library serves three purposes: makes parsing JSON configuration file much easie

Qian Chen 184 Sep 26, 2022
Automatically generate Go (golang) struct definitions from example JSON

gojson gojson generates go struct definitions from json or yaml documents. Example $ curl -s https://api.github.com/repos/chimeracoder/gojson | gojson

Aditya Mukerjee 2.5k Sep 20, 2022
A JSON diff utility

JayDiff A JSON diff utility. Install Downloading the compiled binary Download the latest version of the binary: releases extract the archive and place

Guillaume de Sagazan 92 Sep 27, 2022
Fast and flexible JSON encoder for Go

Jettison Jettison is a fast and flexible JSON encoder for the Go programming language, inspired by bet365/jingo, with a richer features set, aiming at

William Poussier 135 Sep 15, 2022
Console JSON formatter with query feature

Console JSON formatter with query feature. Install: $ go get github.com/miolini/jsonf Usage: Usage of jsonf: -c=true: colorize output -d=false: de

Artem Andreenko 63 Jan 23, 2022
Arbitrary transformations of JSON in Golang

kazaam Description Kazaam was created with the goal of supporting easy and fast transformations of JSON data with Golang. This functionality provides

Qntfy 238 Sep 15, 2022
Parsing JSON is a hassle in golang

GoJSON Parsing JSON is a hassle in golang. This package will allow you to parse and search elements in a json without structs. Install gojson go get g

swaraj18 25 Nov 12, 2021