json-to-struct

README

json-to-struct

json-to-struct attempts to generate go struct definitions from json documents

Online Version Here

Example

$ curl -s https://api.github.com/users/tmc | json-to-struct -name=User
package main

type User struct {
	AvatarURL         string      `json:"avatar_url"`
	Bio               interface{} `json:"bio"`
	Blog              string      `json:"blog"`
	Company           string      `json:"company"`
	CreatedAt         string      `json:"created_at"`
	Email             string      `json:"email"`
	EventsURL         string      `json:"events_url"`
	Followers         float64     `json:"followers"`
	FollowersURL      string      `json:"followers_url"`
	Following         float64     `json:"following"`
	FollowingURL      string      `json:"following_url"`
	GistsURL          string      `json:"gists_url"`
	GravatarID        string      `json:"gravatar_id"`
	Hireable          bool        `json:"hireable"`
	HtmlURL           string      `json:"html_url"`
	ID                float64     `json:"id"`
	Location          string      `json:"location"`
	Login             string      `json:"login"`
	Name              string      `json:"name"`
	OrganizationsURL  string      `json:"organizations_url"`
	PublicGists       float64     `json:"public_gists"`
	PublicRepos       float64     `json:"public_repos"`
	ReceivedEventsURL string      `json:"received_events_url"`
	ReposURL          string      `json:"repos_url"`
	StarredURL        string      `json:"starred_url"`
	SubscriptionsURL  string      `json:"subscriptions_url"`
	Type              string      `json:"type"`
	UpdatedAt         string      `json:"updated_at"`
	URL               string      `json:"url"`
}

Installation

$ go get github.com/tmc/json-to-struct

Related Work

github.com/ChimeraCoder/gojson github.com/str1ngs/jflect

License

json-to-struct is free software distributed under Version 3 of the GNU Public License.

As of the time of writing, this is the same license used for gcc (and therefore gccgo), so it is unlikely to restrict use in any way. Note that the GPL does not extend to any output generated by json-to-struct; the GPL only applies to software which includes copies of json-to-struct itself.

Documentation

Overview

json-to-struct generates go struct defintions from JSON documents

Reads from stdin and prints to stdout

Example:

curl -s https://api.github.com/users/tmc | json-to-struct -name=User

Output:

package main

type GithubUser struct {
	AvatarURL         string      `json:"avatar_url,omitempty"`
	Bio               string      `json:"bio,omitempty"`
	Blog              string      `json:"blog,omitempty"`
	Company           string      `json:"company,omitempty"`
	CreatedAt         string      `json:"created_at,omitempty"`
	Email             interface{} `json:"email,omitempty"`
	EventsURL         string      `json:"events_url,omitempty"`
	Followers         float64     `json:"followers,omitempty"`
	FollowersURL      string      `json:"followers_url,omitempty"`
	Following         float64     `json:"following,omitempty"`
	FollowingURL      string      `json:"following_url,omitempty"`
	GistsURL          string      `json:"gists_url,omitempty"`
	GravatarID        string      `json:"gravatar_id,omitempty"`
	Hireable          bool        `json:"hireable,omitempty"`
	HtmlURL           string      `json:"html_url,omitempty"`
	ID                float64     `json:"id,omitempty"`
	Location          string      `json:"location,omitempty"`
	Login             string      `json:"login,omitempty"`
	Name              string      `json:"name,omitempty"`
	NodeID            string      `json:"node_id,omitempty"`
	OrganizationsURL  string      `json:"organizations_url,omitempty"`
	PublicGists       float64     `json:"public_gists,omitempty"`
	PublicRepos       float64     `json:"public_repos,omitempty"`
	ReceivedEventsURL string      `json:"received_events_url,omitempty"`
	ReposURL          string      `json:"repos_url,omitempty"`
	SiteAdmin         bool        `json:"site_admin,omitempty"`
	StarredURL        string      `json:"starred_url,omitempty"`
	SubscriptionsURL  string      `json:"subscriptions_url,omitempty"`
	Type              string      `json:"type,omitempty"`
	UpdatedAt         string      `json:"updated_at,omitempty"`
	URL               string      `json:"url,omitempty"`
}

json-to-struct generates go struct defintions from JSON documents

Reads from stdin and prints to stdout

Example:

curl -s https://api.github.com/users/tmc | json-to-struct -name=User

Output:

package main

type GithubUser struct {
	AvatarURL         string      `json:"avatar_url,omitempty"`
	Bio               string      `json:"bio,omitempty"`
	Blog              string      `json:"blog,omitempty"`
	Company           string      `json:"company,omitempty"`
	CreatedAt         string      `json:"created_at,omitempty"`
	Email             interface{} `json:"email,omitempty"`
	EventsURL         string      `json:"events_url,omitempty"`
	Followers         float64     `json:"followers,omitempty"`
	FollowersURL      string      `json:"followers_url,omitempty"`
	Following         float64     `json:"following,omitempty"`
	FollowingURL      string      `json:"following_url,omitempty"`
	GistsURL          string      `json:"gists_url,omitempty"`
	GravatarID        string      `json:"gravatar_id,omitempty"`
	Hireable          bool        `json:"hireable,omitempty"`
	HtmlURL           string      `json:"html_url,omitempty"`
	ID                float64     `json:"id,omitempty"`
	Location          string      `json:"location,omitempty"`
	Login             string      `json:"login,omitempty"`
	Name              string      `json:"name,omitempty"`
	NodeID            string      `json:"node_id,omitempty"`
	OrganizationsURL  string      `json:"organizations_url,omitempty"`
	PublicGists       float64     `json:"public_gists,omitempty"`
	PublicRepos       float64     `json:"public_repos,omitempty"`
	ReceivedEventsURL string      `json:"received_events_url,omitempty"`
	ReposURL          string      `json:"repos_url,omitempty"`
	SiteAdmin         bool        `json:"site_admin,omitempty"`
	StarredURL        string      `json:"starred_url,omitempty"`
	SubscriptionsURL  string      `json:"subscriptions_url,omitempty"`
	Type              string      `json:"type,omitempty"`
	UpdatedAt         string      `json:"updated_at,omitempty"`
	URL               string      `json:"url,omitempty"`
}