parser

Documentation

Index

• func ConvertToSchema(source interface{}, rootKey string) map[string]*openapi3.SchemaRef
• type Builder
  • func NewBuilder(path PathParser) *Builder
  • func (b *Builder) BuildPathMethod() *openapi3.Swagger
  • func (b *Builder) RequiredField() func(input string) error
  • func (b *Builder) SetSource(source *wizard.Request)
  • func (b *Builder) SetSwagger(sw *openapi3.Swagger)
• type Curl
  • func NewCurl() *Curl
  • func (c *Curl) CreateTemplatePath(path *Path) string
  • func (c *Curl) FindType(s string) string
  • func (c *Curl) Parse() (*Path, error)
  • func (c *Curl) RequiredField() func(input string) error
  • func (c *Curl) SetText(text string)
  • func (c *Curl) SetUniqueName(path *Path)
  • func (c *Curl) Split() ([]string, error)
  • func (c *Curl) Text() string
  • func (c *Curl) Unmarshal(b string) (map[string]interface{}, error)
• type Fetch
  • func NewFetch() *Fetch
  • func (f *Fetch) Parse() (*Path, error)
  • func (f *Fetch) RequiredField() func(input string) error
  • func (f *Fetch) SetText(text string)
• type Parser
  • func NewParser(t Type) (Parser, error)
• type Path
  • func (path *Path) HasAuthorization() bool
• type PathParser
• type Type
• type Variable

Functions

func ConvertToSchema

func ConvertToSchema(source interface{}, rootKey string) map[string]*openapi3.SchemaRef

ConvertToSchema schematization method

Types

type Builder

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

Builder

func NewBuilder

func NewBuilder(path PathParser) *Builder

func (*Builder) BuildPathMethod

func (b *Builder) BuildPathMethod() *openapi3.Swagger

func (*Builder) RequiredField

func (b *Builder) RequiredField() func(input string) error

func (*Builder) SetSource

func (b *Builder) SetSource(source *wizard.Request)

func (*Builder) SetSwagger

func (b *Builder) SetSwagger(sw *openapi3.Swagger)

type Curl

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

Curl structure

func NewCurl

func NewCurl() *Curl

NewCurl processing constructor

func (*Curl) CreateTemplatePath

func (c *Curl) CreateTemplatePath(path *Path) string

CreateTemplatePath - trying to identify variables on the path

func (*Curl) FindType

func (c *Curl) FindType(s string) string

func (*Curl) Parse

func (c *Curl) Parse() (*Path, error)

Parse process the transferred data and return the path.

func (*Curl) RequiredField

func (c *Curl) RequiredField() func(input string) error

RequiredField validation field

func (*Curl) SetText

func (c *Curl) SetText(text string)

SetText

func (*Curl) SetUniqueName

func (c *Curl) SetUniqueName(path *Path)

SetUniqueName

func (*Curl) Split

func (c *Curl) Split() ([]string, error)

Split divide the transmitted messages into commands.

func (*Curl) Text

func (c *Curl) Text() string

func (*Curl) Unmarshal

func (c *Curl) Unmarshal(b string) (map[string]interface{}, error)

Unmarshal

type Fetch

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

func NewFetch

func NewFetch() *Fetch

func (*Fetch) Parse

func (f *Fetch) Parse() (*Path, error)

func (*Fetch) RequiredField

func (f *Fetch) RequiredField() func(input string) error

func (*Fetch) SetText

func (f *Fetch) SetText(text string)

type Parser

type Parser interface {
	SetSource(source *wizard.Request)
	SetSwagger(sw *openapi3.Swagger)
	RequiredField() func(input string) error
	BuildPathMethod() *openapi3.Swagger
}

Parser behavioral abstraction

func NewParser

func NewParser(t Type) (Parser, error)

NewParser factory abstraction

type Path

type Path struct {
	Method         string
	SourceURL      string
	URL            *url.URL
	TemplatePath   string
	Headers        map[string]string
	PathVariables  []*Variable
	QueryVariables []*Variable
	UniqueName     string
	SourceRequest  string
	ParseRequest   map[string]interface{}
}

Path structure that we return after processing

func (*Path) HasAuthorization

func (path *Path) HasAuthorization() bool

HasAuthorization has auth check

type PathParser

type PathParser interface {
	Parse() (*Path, error)
	SetText(text string)
	RequiredField() func(input string) error
}

PathParser behavioral abstraction

type Type

type Type string

var CurlType Type = "curl"

var FetchType Type = "fetch"

type Variable

type Variable struct {
	Example string
	// contains filtered or unexported fields
}

Variable structure for determining path or query variables