parser

Documentation

Index

• Constants
• type Endpoint
  • func NewEndpoint(name string) *Endpoint
• type Parameter
• type Parser
  • func NewParser(filename string) (*Parser, error)
  • func (p *Parser) AddEndpoint(name, description string)
  • func (p *Parser) Parse() error
• type Response
• type ResponseField

Constants

const Object = "Object"

Types

type Endpoint

type Endpoint struct {
	Name        string
	Description string

	Parameters      []Parameter
	ParameterByName map[string]Parameter
	Response        *Response
}

func NewEndpoint

func NewEndpoint(name string) *Endpoint

type Parameter

type Parameter struct {
	Field       string
	Type        string
	Description string
	Tag         string
}

type Parser

type Parser struct {
	Endpoints       []*Endpoint
	EndpointsByName map[string]*Endpoint
	// contains filtered or unexported fields
}

func NewParser

func NewParser(filename string) (*Parser, error)

func (*Parser) AddEndpoint

func (p *Parser) AddEndpoint(name, description string)

func (*Parser) Parse

func (p *Parser) Parse() error

type Response

type Response struct {
	Type   string
	Fields []ResponseField
}

type ResponseField

type ResponseField struct {
	Field       string
	Type        string
	Description string
	Tag         string
}