go-jsonschema

by atombender

atombender / go-jsonschema

A tool to generate Go data types from JSON Schema definitions.

148 Stars 18 Forks Last release: over 1 year ago (v0.7.0) MIT License 48 Commits 9 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

go-jsonschema is a tool to generate Go data types from JSON Schema definitions.

This tool generates Go data types and structs that corresponds to definitions in the schema, along with unmarshaling code that validates the input JSON according to the schema's validation rules.

Installing

  • Binary install: Get a release here.

  • From source: Go 1.11 or later, with Go modules enabled, is advisable in order to get the right dependencies. To install:

$ go get github.com/atombender/go-jsonschema/...
$ go install github.com/atombender/go-jsonschema/cmd/gojsonschema

Usage

At its most basic:

$ gojsonschema -p main schema.json

This will write a Go source file to standard output, declared under the package

main
.

You can generate code for multiple schemas in the same invocation, optionally writing to different files inside different packages:

$ gojsonschema \
  --schema-package=https://example.com/schema1=github.com/myuser/myproject \
   --schema-output=https://example.com/schema1=schema1.go \
  --schema-package=https://example.com/schema2=github.com/myuser/myproject/stuff \
   --schema-output=https://example.com/schema2=stuff/schema2.go \
  schema1.json schema2.json

This will create

schema1.go
(declared as
package myproject
) and
stuff/schema2.go
(declared as
package stuff
). If
schema1.json
refers to
schema2.json
or vice versa, the two Go files will import the other package that it depends on. Note the flag format:
--schema-package=https://example.com/schema1=github.com/myuser/myproject \
                 ^                           ^
                 |                           |
                 schema $id                  full import URL

Status

While not finished, go-jsonschema can be used today. Aside from some minor features, only specific validations remain to be fully implemented.

Validation

  • Core (RFC draft)
    • [x] Data model (§4.2.1)
    • [x]
      null
    • [x]
      boolean
    • [x]
      object
    • [x]
      array
    • [x]
      number
      • [ ] Option to use
        json.Number
    • [x]
      string
    • [ ] Location identifiers (§8.2.3)
    • [x] References against top-level names:
      #/Definitions/someName
    • [ ] References against nested names:
      #/Definitions/someName/Definitions/someOtherName
    • [x] References against top-level names in external files:
      myschema.json#/Definitions/someName
    • [ ] References against nested names:
      myschema.json#/Definitions/someName/Definitions/someOtherName
    • [x] Comments (§9)
  • Validation (RFC draft)
    • [ ] Schema annotations (§10)
    • [x]
      description
    • [x]
      default
      (only for struct fields)
    • [ ]
      readOnly
    • [ ]
      writeOnly
    • [ ] ~~
      title
      ~~ (N/A)
    • [ ] ~~
      examples
      ~~ (N/A)
    • [ ] General validation (§6.1)
    • [x]
      enum
    • [x]
      type
      (single)
    • [x]
      type
      (multiple; note: partial support, limited validation)
    • [ ]
      const
    • [ ] Numeric validation (§6.2)
    • [ ]
      multipleOf
    • [ ]
      maximum
    • [ ]
      exclusiveMaximum
    • [ ]
      minimum
    • [ ]
      exclusiveMinimum
    • [ ] String validation (§6.3)
    • [ ]
      maxLength
    • [ ]
      minLength
    • [ ]
      pattern
    • [ ] Array validation (§6.4)
    • [X]
      items
    • [ ]
      maxItems
    • [ ]
      minItems
    • [ ]
      uniqueItems
    • [ ]
      additionalItems
    • [ ]
      contains
    • [ ] Object validation (§6.5)
    • [x]
      required
    • [x]
      properties
    • [ ]
      patternProperties
    • [ ]
      dependencies
    • [ ]
      propertyNames
    • [ ]
      maxProperties
    • [ ]
      minProperties
    • [ ] Conditional subschemas (§6.6)
    • [ ]
      if
    • [ ]
      then
    • [ ]
      else
    • [ ] Boolean subschemas (§6.7)
    • [ ]
      allOf
    • [ ]
      anyOf
    • [ ]
      oneOf
    • [ ]
      not
    • [ ] Semantic formats (§7.3)
    • [ ] Dates and times
    • [ ] Email addresses
    • [ ] Hostnames
    • [ ] IP addresses
    • [ ] Resource identifiers
    • [ ] URI-template
    • [ ] JSON pointers
    • [ ] Regex

License

MIT license. See

LICENSE
file.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.