generator

Documentation

Index

• type Generator
  • func NewGenerator() *Generator
  • func (*Generator) GetAnnotationSymbol() generator.AnnotationSymbol
  • func (*Generator) GetFormatter() generator.Formatter
  • func (api *Generator) Run(pkg *generator.PackageInfo, nodes []*generator.AnnotatedNode) ([]*generator.Result, error)
• type ParameterType
  • func (pt *ParameterType) ResolveAlias(d *generator.Dependency)
  • func (pt *ParameterType) String() string
• type Spec
• type SpecGroup
• type StructuredParameter

Types

type Generator

type Generator struct {
}

Generator is a generator for HTTP API sources

func NewGenerator

func NewGenerator() *Generator

NewGenerator returns a new instance of Generator

func (*Generator) GetAnnotationSymbol

func (*Generator) GetAnnotationSymbol() generator.AnnotationSymbol

GetAnnotationSymbol implements generator.Generator#GetAnnotationSymbol

func (*Generator) GetFormatter

func (*Generator) GetFormatter() generator.Formatter

GetFormatter implements generator.Generator#GetFormatter

func (*Generator) Run

func (api *Generator) Run(pkg *generator.PackageInfo, nodes []*generator.AnnotatedNode) ([]*generator.Result, error)

Run implementes generator.Generator#Run

type ParameterType

type ParameterType struct {
	Name         string
	Package      string
	PackageAlias string
}

ParameterType represents the type information for a parameter

func (*ParameterType) ResolveAlias

func (pt *ParameterType) ResolveAlias(d *generator.Dependency)

ResolveAlias resolves PackageAlias field with the given Dependency object.

func (*ParameterType) String

func (pt *ParameterType) String() string

type Spec

type Spec struct {
	ReceiverTypeName    string
	ReceiverName        string
	PathPattern         string
	PathParameters      []string
	StructuredParameter *StructuredParameter
	FuncName            string
	Method              requestMethod
	ReturnType          returnType
}

Spec represents API specification

type SpecGroup

type SpecGroup struct {
	ReceiverTypeName string
	ReceiverName     string
	Specs            []*Spec
}

SpecGroup is a struct to group by ReceiverTypeName

type StructuredParameter

type StructuredParameter struct {
	Type   *ParameterType
	Parser *api.ParameterParser
}