schema

package

v0.1.0 Latest Latest Go to latest Published: Aug 9, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/arhat-dev/schemer

Documentation ¶

Index ¶

func ToJSON(v interface{}) ([]byte, error)
type Schema
- func GenerateSchema(pkgPath string, rootRef string, tagNamespace string, ...) (Schema, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ToJSON ¶

func ToJSON(v interface{}) ([]byte, error)

ToJSON serializes and makes sure HTML description are not escaped

Types ¶

type Schema ¶

type Schema struct {
	*definition.Definition
	Version     string                            `json:"$schema,omitempty"`
	Definitions map[string]*definition.Definition `json:"definitions,omitempty"`
}

Schema represents a JSON Schema

func GenerateSchema ¶

func GenerateSchema(
	pkgPath string,
	rootRef string,
	tagNamespace string,
	formatRefName definition.RefNameFormatFunc,
	strict bool,
) (Schema, error)

GenerateSchema is the entrypoint for schema generation

Source Files ¶

View all Source files

schema.go

Directories ¶

Path	Synopsis
test
subpkg

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL