importer

Documentation

Index

• Constants
• Variables
• func IsBuiltIn(name string) bool
• func LoadOpenAPIText(args OutputData, text string, logger *logrus.Logger) (out string, err error)
• func LoadSwaggerText(args OutputData, text string, logger *logrus.Logger) (out string, err error)
• func LoadXSDText(args OutputData, text string, logger *logrus.Logger) (out string, err error)
• type Alias
  • func (s *Alias) Name() string
• type Array
  • func (s *Array) Name() string
• type Endpoint
• type Enum
  • func (s *Enum) Name() string
• type ExternalAlias
  • func (s *ExternalAlias) Name() string
• type Field
• type FieldList
• type Func
• type ImportedBuiltInAlias
  • func (s *ImportedBuiltInAlias) Name() string
• type IndentWriter
  • func NewIndentWriter(text string, out io.Writer) *IndentWriter
  • func (i *IndentWriter) CurrentIndentLen() int
  • func (i *IndentWriter) Pop()
  • func (i *IndentWriter) Push()
  • func (i *IndentWriter) Write() error
• type MethodEndpoints
• type OutputData
• type Param
• type Parameters
  • func (p *Parameters) Add(param Param)
  • func (p Parameters) BodyParams() []Param
  • func (p *Parameters) Extend(others Parameters) Parameters
  • func (p Parameters) HeaderParams() []Param
  • func (p Parameters) PathParams() []Param
  • func (p Parameters) QueryParams() []Param
• type Response
• type StandardType
  • func (s *StandardType) Name() string
• type SyslBuiltIn
  • func (s *SyslBuiltIn) Name() string
• type SyslInfo
• type Type
  • func NewStringAlias(name string) Type
• type TypeList
  • func (t *TypeList) Add(item ...Type)
  • func (t *TypeList) AddAndRet(item Type) Type
  • func (t TypeList) Find(name string) (Type, bool)
  • func (t TypeList) Items() []Type
  • func (t TypeList) Sort()
• type Union
  • func (u *Union) Name() string

Constants

const (
	ModeOpenAPI = "openapi"
	ModeSwagger = "swagger"
	ModeXSD     = "xsd"
	ModeGrammar = "grammar"
	ModeAuto    = "auto"
)

const (
	StringTypeName = "string"
	ObjectTypeName = "object"
	ArrayTypeName  = "array"
)

const (
	MinOnly maxType = iota
	MaxSpecified
	OpenEnded
)

const BlankLine = "&& !!"

const CommentLineLength = 80

const PopIndent = "&& <<"

const PushIndent = "&& >>"

Variables

var StringAlias = &SyslBuiltIn{name: StringTypeName}

Functions

func IsBuiltIn

func IsBuiltIn(name string) bool

func LoadOpenAPIText

func LoadOpenAPIText(args OutputData, text string, logger *logrus.Logger) (out string, err error)

func LoadSwaggerText

func LoadSwaggerText(args OutputData, text string, logger *logrus.Logger) (out string, err error)

func LoadXSDText

func LoadXSDText(args OutputData, text string, logger *logrus.Logger) (out string, err error)

Types

type Alias

type Alias struct {
	Target Type
	// contains filtered or unexported fields
}

!alias type without the EXTERNAL_ prefix

func (*Alias) Name

func (s *Alias) Name() string

type Array

type Array struct {
	Items Type
	// contains filtered or unexported fields
}

func (*Array) Name

func (s *Array) Name() string

type Endpoint

type Endpoint struct {
	Path        string
	Description string

	Params Parameters

	Responses []Response
}

type Enum

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

func (*Enum) Name

func (s *Enum) Name() string

type ExternalAlias

type ExternalAlias struct {
	Target Type
	// contains filtered or unexported fields
}

func (*ExternalAlias) Name

func (s *ExternalAlias) Name() string

type Field

type Field struct {
	Name       string
	Type       Type
	Optional   bool
	Attributes []string
	SizeSpec   *sizeSpec
}

type FieldList

type FieldList []Field

type Func

type Func func(args OutputData, text string, logger *logrus.Logger) (out string, err error)

type ImportedBuiltInAlias

type ImportedBuiltInAlias struct {
	Target Type
	// contains filtered or unexported fields
}

func (*ImportedBuiltInAlias) Name

func (s *ImportedBuiltInAlias) Name() string

type IndentWriter

type IndentWriter struct {
	io.Writer
	// contains filtered or unexported fields
}

func NewIndentWriter

func NewIndentWriter(text string, out io.Writer) *IndentWriter

func (*IndentWriter) CurrentIndentLen

func (i *IndentWriter) CurrentIndentLen() int

func (*IndentWriter) Pop

func (i *IndentWriter) Pop()

func (*IndentWriter) Push

func (i *IndentWriter) Push()

func (*IndentWriter) Write

func (i *IndentWriter) Write() error

type MethodEndpoints

type MethodEndpoints struct {
	Method    string // one of GET, POST, PUT, OPTION, etc
	Endpoints []Endpoint
}

type OutputData

type OutputData struct {
	AppName     string
	Package     string
	SwaggerRoot string
	Mode        string
}

type Param

type Param struct {
	Field
	In string
}

type Parameters

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

func (*Parameters) Add

func (p *Parameters) Add(param Param)

func (Parameters) BodyParams

func (p Parameters) BodyParams() []Param

func (*Parameters) Extend

func (p *Parameters) Extend(others Parameters) Parameters

func (Parameters) HeaderParams

func (p Parameters) HeaderParams() []Param

func (Parameters) PathParams

func (p Parameters) PathParams() []Param

func (Parameters) QueryParams

func (p Parameters) QueryParams() []Param

type Response

type Response struct {
	Text string
	Type Type
}

Response is either going to be freetext or a type

type StandardType

type StandardType struct {
	Properties FieldList
	Attributes []string
	// contains filtered or unexported fields
}

func (*StandardType) Name

func (s *StandardType) Name() string

type SyslBuiltIn

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

func (*SyslBuiltIn) Name

func (s *SyslBuiltIn) Name() string

type SyslInfo

type SyslInfo struct {
	OutputData

	Title       string
	Description string
	OtherFields []string // Ordered key, val pair
}

type Type

type Type interface {
	Name() string
}

func NewStringAlias

func NewStringAlias(name string) Type

type TypeList

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

func (*TypeList) Add

func (t *TypeList) Add(item ...Type)

func (*TypeList) AddAndRet

func (t *TypeList) AddAndRet(item Type) Type

func (TypeList) Find

func (t TypeList) Find(name string) (Type, bool)

func (TypeList) Items

func (t TypeList) Items() []Type

func (TypeList) Sort

func (t TypeList) Sort()

type Union

type Union struct {
	Options FieldList
	// contains filtered or unexported fields
}

func (*Union) Name

func (u *Union) Name() string