go-json-doc

Go documentation generator for JSON structs.

go-json-doc uses reflection to generate JSON schemas for go structs.

Usage

API documentation can be read at Godoc.

doc, err := jsondoc.NewGlossary().Describe(new(struct{
  Name string
  Age int
  Occupation `json:"Job"`
}))

fmt.Println(doc)
// {
//   "Name": "<string>",
//   "Age": "<string>",
//   "Job": "<string>"
// }

A more complete example can be found in the examples directory.

Contribute

PRs accepted.

Contributors

• Steven Allen (@stebalien)
• Initial concept by Hector Sanjuan (@hsanjuan)

License

MIT © Steven Allen