parser

Documentation

Index

• Constants
• func Parse(data *ifacetool.Data, snakeCase bool) (*spec.Specification, docutil.Transport, error)
• type OpBuilder
  • func (b *OpBuilder) Build(method *ifacetool.Method) ([]*spec.Operation, error)
• type PathVarNames
  • func (pvn *PathVarNames) Add(names []string)
  • func (pvn *PathVarNames) Get(i int) []string
  • func (pvn *PathVarNames) Squash() []string
• type StructField
  • func (f *StructField) Parse() error

Constants

const (
	OptionNoRequestBody = "-"
)

Functions

func Parse

func Parse(data *ifacetool.Data, snakeCase bool) (*spec.Specification, docutil.Transport, error)

Types

type OpBuilder

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

func (*OpBuilder) Build

func (b *OpBuilder) Build(method *ifacetool.Method) ([]*spec.Operation, error)

type PathVarNames

type PathVarNames [][]string

func (*PathVarNames) Add

func (pvn *PathVarNames) Add(names []string)

func (*PathVarNames) Get

func (pvn *PathVarNames) Get(i int) []string

func (*PathVarNames) Squash

func (pvn *PathVarNames) Squash() []string

Squash de-duplicates all the nested names and squash them into a flat list.

type StructField

type StructField struct {
	Name      string
	CamelCase bool
	Type      string
	Tag       reflect.StructTag

	Omitted bool              // Whether to omit this field.
	Params  []*spec.Parameter // The associated annotation parameters.
}

func (*StructField) Parse

func (f *StructField) Parse() error