tspec

Documentation

Index

• Constants
• Variables
• func ParsePkgWithDecorator(pkg *ast.Package, decorator string) (objs map[string]*ast.Object, err error)
• type Parser
  • func NewParser() (parser *Parser)
  • func (t *Parser) Definitions() (defs spec.Definitions)
  • func (t *Parser) Import(pkgPath string) (pkg *ast.Package, err error)
  • func (t *Parser) Options(opts ...ParserOptions) ParserOptions
  • func (t *Parser) Parse(oPkg *ast.Package, typeStr string) (schema *spec.Schema, err error)
  • func (t *Parser) ParseDir(dirPath string, pkgName string, opts ...bool) (pkg *ast.Package, cached bool, err error)
  • func (t *Parser) ParsePkg(pkg *ast.Package) (objs map[string]*ast.Object, err error)
  • func (t *Parser) Reset()
• type ParserOptions

Constants

const (
	// DefaultRefPrefix defines the default value of ref prefix
	DefaultRefPrefix = "#/definitions/"
)

Variables

var DefaultParserOptions = ParserOptions{
	IgnoreJSONTag: false,
	RefPrefix:     DefaultRefPrefix,
}

DefaultParserOptions defines default tspec parser options

Functions

func ParsePkgWithDecorator

func ParsePkgWithDecorator(pkg *ast.Package, decorator string) (objs map[string]*ast.Object, err error)

ParsePkgWithDecorator parses package and returns all types with the gaven decorator

Types

type Parser

type Parser struct {
	// contains filtered or unexported fields
}

Parser defines tspec parser

func NewParser

func NewParser() (parser *Parser)

NewParser returns a new tspec parser

func (*Parser) Definitions

func (t *Parser) Definitions() (defs spec.Definitions)

Definitions returns all related definitions

func (*Parser) Import

func (t *Parser) Import(pkgPath string) (pkg *ast.Package, err error)

Import imports package dir and returns related package

func (*Parser) Options

func (t *Parser) Options(opts ...ParserOptions) ParserOptions

Options gets or sets parser options

func (*Parser) Parse

func (t *Parser) Parse(oPkg *ast.Package, typeStr string) (
	schema *spec.Schema, err error)

Parse parses type expr and returns related json schema

func (*Parser) ParseDir

func (t *Parser) ParseDir(dirPath string, pkgName string, opts ...bool) (pkg *ast.Package, cached bool, err error)

ParseDir parses the dir and cache it

func (*Parser) ParsePkg

func (t *Parser) ParsePkg(pkg *ast.Package) (objs map[string]*ast.Object, err error)

ParsePkg collects all objs and cache them

func (*Parser) Reset

func (t *Parser) Reset()

Reset cleans all definitions

type ParserOptions

type ParserOptions struct {
	IgnoreJSONTag bool
	RefPrefix     string
}

ParserOptions defines tspec parser options