extractor

Documentation

Index

• type Extractor
  • func New(path string) (*Extractor, error)
  • func (e *Extractor) Extract() ([]Route, []Struct)
• type Field
• type Route
• type Struct

Types

type Extractor

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

func New

func New(path string) (*Extractor, error)

New parses the file at path and returns an extractor with its contents.

func (*Extractor) Extract

func (e *Extractor) Extract() ([]Route, []Struct)

Extract reads the JSON document and extracts all the routes and structs from it.

type Field

type Field struct {
	Name       string
	IsArray    bool
	IsOptional bool
	Type       string
}

type Route

type Route struct {
	Name       string
	Summary    string
	Method     string
	Path       string
	ParamsName string
	ReturnName string
}

type Struct

type Struct struct {
	Name       string
	Fields     []Field
	UnionNames []string
}