schema

README

github.com/go-json-schema/schema

JSON Schema for Go: handles definition, and marshaling/unmarshaling JSON schemas

SYNOPSIS

package schema_test

import (
  "encoding/json"
  "log"
  "strings"

  "github.com/go-json-schema/schema"
  "github.com/go-json-schema/schema/draft04"
  "github.com/go-json-schema/schema/draft07"
)

func Example() {
  // Parse the draft-07 schema
  s, err := schema.Parse(strings.NewReader(draft07.MetaSchema))
  if err != nil {
    log.Printf("failed to parse schema: %s", err)
    return
  }

  // Check if this is a draft-04 or draft-07 schema
  switch s.SchemaRef() {
  case draft04.SchemaID:
    // do draft-04 specific stuff...
    // s.(*draft04.Schema)
  case draft07.SchemaID:
    // do draft-07 specific stuff...
    // s.(*draft07.Schema)
  default:
    log.Printf("unknown schema")
  }

  // Marshal it back to JSON
  buf, err := json.MarshalIndent(s, "", "  ")
  if err != nil {
    log.Printf("failed to marshal schema: %s", err)
    return
  }
  _ = buf
  // OUTPUT:
}

DESCRIPTION

This library can parse various JSON schema versions into a struct, which you can then use to manipulate, such as to build a validator.

SUPPORTED VERSIONS

• draft-04
• draft-07

Documentation

Overview

Example

package main

import (
	"encoding/json"
	"log"
	"strings"

	"github.com/go-json-schema/schema"
	"github.com/go-json-schema/schema/draft04"
	"github.com/go-json-schema/schema/draft07"
)

func main() {
	// Parse the draft-07 schema
	s, err := schema.Parse(strings.NewReader(draft07.MetaSchema))
	if err != nil {
		log.Printf("failed to parse schema: %s", err)
		return
	}

	// Check if this is a draft-04 or draft-07 schema
	switch s.SchemaRef() {
	case draft04.SchemaID:
		// do draft-04 specific stuff...
	case draft07.SchemaID:
		// do draft-07 specific stuff...
	default:
		log.Printf("unknown schema")
	}

	// Marshal it back to JSON
	buf, err := json.MarshalIndent(s, "", "  ")
	if err != nil {
		log.Printf("failed to marshal schema: %s", err)
		return
	}
	_ = buf
}

Index

• type EnumList
• type Option
  • func WithSchemaID(s string) Option
• type Schema
  • func Parse(src io.Reader, options ...Option) (s Schema, err error)
  • func ParseFile(fn string, options ...Option) (Schema, error)

Examples

• Package

Types

type EnumList

type EnumList = common.EnumList

type Option

type Option = common.Option

func WithSchemaID

func WithSchemaID(s string) Option

type Schema

type Schema = common.Schema

func Parse

func Parse(src io.Reader, options ...Option) (s Schema, err error)

func ParseFile

func ParseFile(fn string, options ...Option) (Schema, error)