schemakit generate¶

Generate JSON Schema from Go struct types using reflection.

Usage¶

schemakit generate <package> <type> [flags]

Flags¶

Flag	Description
`-o, --output`	Output file (default: stdout)
`--indent`	Indent JSON output (default: true)

Examples¶

# Generate to stdout
schemakit generate github.com/myorg/myproject/types Config

# Save to file
schemakit generate -o schema.json github.com/myorg/myproject/types Config

# Without indentation
schemakit generate --indent=false github.com/myorg/myproject/types Config

How It Works¶

The command creates a temporary Go program that:

Imports your target package
Uses invopop/jsonschema to reflect on the type
Generates a JSON Schema with $defs for nested types

Module Resolution¶

The command supports both local and remote packages:

Local modules: Packages in $GOPATH/src are resolved via replace directives
Remote modules: Packages are fetched via go get

Struct Tags¶

The generated schema respects these struct tags:

Tag	Effect
`json:"name"`	Sets the property name
`json:",omitempty"`	Marks field as optional
`json:"-"`	Excludes field from schema
`jsonschema:"title=X"`	Sets schema title
`jsonschema:"description=X"`	Sets schema description
`jsonschema:"enum=a,b,c"`	Defines enum values

Example Output¶

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "config",
  "$defs": {
    "Database": {
      "type": "object",
      "properties": {
        "host": { "type": "string" },
        "port": { "type": "integer" }
      },
      "required": ["host", "port"]
    }
  },
  "type": "object",
  "properties": {
    "database": { "$ref": "#/$defs/Database" }
  }
}