go-jsonschema-generator's Introduction

go-jsonschema-generator

Basic json-schema generator based on Go types, for easy interchange of Go structures across languages.

Installation

The recommended way to install go-jsonschema-generator

go get github.com/mcuadros/go-jsonschema-generator

Examples

A basic example:

package main

import (
  "fmt"
  "github.com/mcuadros/go-jsonschema-generator"
)

type EmbeddedType struct {
  Zoo string
}

type Item struct {
  Value string
}

type ExampleBasic struct {
  Foo bool   `json:"foo"`
  Bar string `json:",omitempty"`
  Qux int8
  Baz []string
  EmbeddedType
  List []Item
}

func main() {
  s := &jsonschema.Document{}
  s.Read(&ExampleBasic{})
  fmt.Println(s)
}

{
    "$schema": "http://json-schema.org/schema#",
    "type": "object",
    "properties": {
        "Bar": {
            "type": "string"
        },
        "Baz": {
            "type": "array",
            "items": {
                "type": "string"
            }
        },
        "List": {
            "type": "array",
            "items": {
                "type": "object",
                "properties": {
                    "Value": {
                        "type": "string"
                    }
                },
                "required": [
                    "Value"
                ]
            }
        },
        "Qux": {
            "type": "integer"
        },
        "Zoo": {
            "type": "string"
        },
        "foo": {
            "type": "boolean"
        }
    },
    "required": [
        "foo",
        "Qux",
        "Baz",
        "Zoo",
        "List"
    ]
}

License

MIT, see LICENSE

go-jsonschema-generator's People

Contributors

Stargazers

Watchers

go-jsonschema-generator's Issues

Feature: Deep reading values and generating schema

Currently the repo supports reading the type alone and generating schema

I have forked this repo here - https://github.com/karuppiah7890/go-jsonschema-generator to add functions to do a deep read - where the all the values of the input are read in a deep manner - that is - read all the nested values too and find out the json schema for it. Do check the source code. I have used the forked repo in this application - https://github.com/karuppiah7890/helm-schema-gen

If the fork code looks good, I can contribute back to this repo. I just have a feeling that the implementation is not great or perfect - but it works - at least I have tests for the cases it works for 😅