core

Documentation

Index

• type JApiCore
  • func NewJApiCore(file *fs.File) *JApiCore
  • func (core *JApiCore) BuildResourceMethodsPathVariables() *jerr.JAPIError
  • func (core *JApiCore) Catalog() *catalog.Catalog
  • func (core *JApiCore) CheckRawPathVariableSchemas() *jerr.JAPIError
  • func (core *JApiCore) ExpandRawPathVariableShortcuts() *jerr.JAPIError
  • func (core *JApiCore) HasUnclosedExplicitContext() bool
  • func (core *JApiCore) ProcessAllOf() *jerr.JAPIError
  • func (core *JApiCore) ValidateJAPI() *jerr.JAPIError
• type PathParameter
  • func PathParameters(path string) ([]PathParameter, error)

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) *JApiCore

func (*JApiCore) BuildResourceMethodsPathVariables

func (core *JApiCore) BuildResourceMethodsPathVariables() *jerr.JAPIError

func (*JApiCore) Catalog

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

func (*JApiCore) CheckRawPathVariableSchemas

func (core *JApiCore) CheckRawPathVariableSchemas() *jerr.JAPIError

func (*JApiCore) ExpandRawPathVariableShortcuts

func (core *JApiCore) ExpandRawPathVariableShortcuts() *jerr.JAPIError

func (*JApiCore) HasUnclosedExplicitContext

func (core *JApiCore) HasUnclosedExplicitContext() bool

func (*JApiCore) ProcessAllOf

func (core *JApiCore) ProcessAllOf() *jerr.JAPIError

func (*JApiCore) ValidateJAPI

func (core *JApiCore) ValidateJAPI() *jerr.JAPIError

ValidateJAPI should be used to check if .jst file is valid according to specification

type PathParameter

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

func PathParameters

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