jsonschema

go-jsonschema

A JSON schema code generator for Go, supporting draft 2020-12, supporting reference resolving between multiple schema files.

This module is a fork of git.sr.ht/~emersion/go-jsonschema, with the following improvement:

• Support stdin and stdout for input and output.
• Support multiple schema files. Will resolve references between files correctly.
• Support base local directory for resolving relative references, and base URI for resolving downloaded references.
• Support special uppercase field names, such as ID and URL.
• Support additional properties and pattern properties.

For the above features, we introduce some breaking changes, so I publish this module instead of raising a PR.

Installation

go install github.com/RyoJerryYu/go-jsonschema/cmd/jsonschemagen

Usage

jsonschemagen -s <schema> -o <output>

Or, with the support of stdin/stdout and multiple schema files:

find schema -name '*.json' | xargs jsonschemagen --rootdir=$PWD -n structs -u id -u url > out/generated.go

Full usage:

Generate Go types and helpers for the specified JSON schema.
If no schema file is specified or specified to "-", read from stdin.

Usage:
  jsonschemagen [flags] [schema file]...

Examples:
$ find schema -name '*.json' | xargs jsonschemagen --rootdir=$PWD -n out > out/generated.go

Flags:
      --baseuri string                 base URI
  -h, --help                           help for jsonschemagen
  -o, --output string                  The output filename.
                                       If not provided or specified to "-", output to stdout.
  -n, --packagename string             package name
      --rootdir string                 root directory
  -s, --schema string                  The schema filename, deprecated.
                                       recommended to use positional argument.
                                       "-" for stdin.
  -u, --upper-property-names strings   Apply full upper case to the property names.
                                       e.g. given "id", "Id" or "ID" as flags, when a type or field name 
                                       parsed as "Id", would be converted as "ID"
      --with-additional-properties     Generate additional properties and pattern properties

One Go type per definition will be generated.

• int64 is used for "type": "integer".
• json.Number is used for "type": "number".
• schemas with "type": ["null", <other>] and {"oneOf": [{"type": "null"}, <other>]} are considered as optional, will be generated as *<other>.
• Resolvable references are generated as the corresponding Go type. Non-resolvable references are generated as json.RawMessage.
• Additional properties and pattern properties are not generated by default. Use --with-additional-properties to generate them as map[string]json.RawMessage .

License

MIT