struct2json

package module

v0.0.0-...-45d8dff Latest Latest Go to latest Published: Jan 5, 2020 License: MIT Imports: 8 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Dump a Go struct definition as JSON

This section is empty.

This section is empty.

This section is empty.

type Document struct {
	Structs []Struct `json:"structs"`
}

Document contains a series of Structs

func GetStructs(goFileName string) Document

GetStructs parses a single .go file, finding all declared/named structs.

func (doc *Document) Append(structs ...Struct)

Append adds other structs to this Document

func (doc Document) Get(name string) (Struct, bool)

Get returns the Struct with the given name. The bool value indicates if the given name was found or not.

func (doc *Document) WriteJSON(w io.Writer)

WriteJSON outputs a Document as JSON.

type Field struct {
	Name string            `json:"name"`
	Type string            `json:"type"`
	Tags map[string]string `json:"tags,omitempty"`
}

Field contains a name, a type, and possibly some Tags

type Struct struct {
	Name   string  `json:"name"`
	Fields []Field `json:"fields"`
}

Struct contains a name, and a series of Fields

Path	Synopsis
cmd
sample