core

Documentation

Index

• type JApiCore
  • func NewJApiCore(file *fs.File, oo ...Option) *JApiCore
  • func (core *JApiCore) AddRawUserType(d *directive.Directive)
  • func (core *JApiCore) BuildCatalog() *jerr.JApiError
  • func (core *JApiCore) Catalog() *catalog.Catalog
  • func (core *JApiCore) HasUnclosedExplicitContext() bool
  • func (core *JApiCore) UserTypesData() map[string]*jschema.JSchema
• type Option
  • func WithBannedDirectives(dd ...directive.Enumeration) Option
• type PathParameter
  • func PathParameters(path string) ([]PathParameter, error)
• type PieceOfPathVariable
  • func PieceOfPathVariableImitation() PieceOfPathVariable

Types

type JApiCore

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

JApiCore the Brain and heart of jApi. Collects lexemes from scanner, validates document logic and structure, builds catalog, renders documentation

func NewJApiCore

func NewJApiCore(file *fs.File, oo ...Option) *JApiCore

func (*JApiCore) AddRawUserType

func (core *JApiCore) AddRawUserType(d *directive.Directive)

func (*JApiCore) BuildCatalog

func (core *JApiCore) BuildCatalog() *jerr.JApiError

func (*JApiCore) Catalog

func (core *JApiCore) Catalog() *catalog.Catalog

func (*JApiCore) HasUnclosedExplicitContext

func (core *JApiCore) HasUnclosedExplicitContext() bool

func (*JApiCore) UserTypesData

func (core *JApiCore) UserTypesData() map[string]*jschema.JSchema

type Option

type Option func(*JApiCore)

func WithBannedDirectives

func WithBannedDirectives(dd ...directive.Enumeration) Option

WithBannedDirectives ban specified directives. Core will emit an error if found one of them.

type PathParameter

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

func PathParameters

func PathParameters(path string) ([]PathParameter, error)

type PieceOfPathVariable

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

func PieceOfPathVariableImitation

func PieceOfPathVariableImitation() PieceOfPathVariable

imitates piece for param, gatherd from URL or Method-directive, not from Path schema.