parse

Documentation

Index

• type Converter
  • func NewConverter(log logger.Logger, parsers []Parser) Converter
• type ConverterImpl
  • func (c *ConverterImpl) Convert(ctx context.Context, file *fileresource.FileResource) (*apispecdoc.ApiSpecDoc, error)
• type Parser

Types

type Converter

type Converter interface {
	Convert(ctx context.Context, file *fileresource.FileResource) (*apispecdoc.ApiSpecDoc, error)
}

Converter converts file data to API specification document using specific file type

func NewConverter

func NewConverter(log logger.Logger, parsers []Parser) Converter

type ConverterImpl

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

func (*ConverterImpl) Convert

func (c *ConverterImpl) Convert(ctx context.Context, file *fileresource.FileResource) (*apispecdoc.ApiSpecDoc, error)

Convert gets bytes slice with json/yaml content and a filetype matching the type of the content and returns parsed ApiSpecDoc.

type Parser

type Parser interface {
	//Parse the bytes slice to a ApiSecDoc
	Parse(ctx context.Context, content []byte) (*apispecdoc.ApiSpecDoc, error)

	//GetType returns the type (json or yaml) of the parser
	GetType() fileresource.AsdFileType
}

Parser is common interface with functionality to parse content of the specific API specification document and to construct ApiSpecDoc object from it