bxcodec / goson

⚡️[WIP] Golang JSON Schema extractor from raw-json string

goson

⚡️[WIP] Golang SIMPLE JSON Schema extractor from raw-json string

Roadmap

Currently with MVP release ( target: stable v1), there are a few things we need to finish. You can view the list in the: https://waffle.io/bxcodec/goson

Contributions

I really appreciate for everyone who willing to help to finish this, you can choose any task from https://waffle.io/bxcodec/goson and make a PR to this repository.

The task with label epic means it's need to finish ASAP.

Example

var (
	example = `{
		"id": "uk123",
		"name": "tom",
		"email": "[email protected]",
		"user": {
			"address": "Sidikalang",
			"age": 23,
			"phones": [
				"08234239523",
				"08234239523"
			]
		},
		"arr": [{
			"site": "string",
			"url": "string"
		}],
		"tags": ["go", "js"],
		"numbers": [3, 4, 5] 
	}`
)
schema,_:=goson.GenerateJSONSchema(example)

jbyt, _ := schema.ToJSON()


fmt.Println(string(jbyt))
/*
 Will Print: 
{"properties":{"arr":{"items":{"properties":{"site":{"type":"string"},"url":{"type":"string"}},"type":"object"},"type":"array"},"email":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"numbers":{"items":{"type":"number"},"type":"array"},"tags":{"items":{"type":"string"},"type":"array"},"user":{"properties":{"address":{"type":"string"},"age":{"type":"number"},"phones":{"items":{"type":"string"},"type":"array"}},"type":"object"}},"type":"object"}
*/

// Or in Formatted data:
/*
{
 "properties": {
	"arr": {
		"items": {
			"properties": {
				"site": {
					"type": "string"
				},
				"url": {
					"type": "string"
				}
			},
			"type": "object"
		},
		"type": "array"
	},
	"email": {
		"type": "string"
	},
	"id": {
		"type": "string"
	},
	"name": {
		"type": "string"
	},
	"numbers": {
		"items": {
			"type": "number"
		},
		"type": "array"
	},
	"tags": {
		"items": {
			"type": "string"
		},
		"type": "array"
	},
	"user": {
		"properties": {
			"address": {
				"type": "string"
			},
			"age": {
				"type": "number"
			},
			"phones": {
				"items": {
					"type": "string"
				},
				"type": "array"
			}
		},
		"type": "object"
	}
	},
	"type": "object"
}
*/

goson's Issues

feat: Extract JSON schema from file

Fix: JSON Schema Extractor for array types

fix: JSON schema for nested array

For example:

{
 "data":[
     [1,2,4], 
     [27,23,62]
   ]
}

chore: Add Test Coverage

chore: beautify the documentations and the examples

feat: Extract JSON schema from URL

feat: Type for null data

Current version:
In the current version, if we generate a schema from JSON with null data will cause an error
Example:

json = {
  "data": null
}

What I proposed is:
Checking the value is type of nil, something like this:

func getType(item interface{}) string {
	switch item.(type) {
	case string:
		return "string"
	...
	case nil:
		return "nil"
	default:
		var r = reflect.TypeOf(item)
		return fmt.Sprintf("%s", r.String())
	}
}

This feature will make sure no error happened when getting null value from response body.