gen

Documentation

Index

• func GenerateSchema(input []byte, fs FileSystem, typeName, fileName, pkgName string) error
• func TypeFormatMapping() map[jsonschema.SchemaType]map[string]ir.PrimitiveType
• type DefaultElem
• type Elem
  • func (e Elem) NextVar() string
• type ErrBuildRouter
  • func (e *ErrBuildRouter) Error() string
  • func (e *ErrBuildRouter) Unwrap() error
• type ErrNotImplemented
  • func (e *ErrNotImplemented) Error() string
• type ErrParseSpec
  • func (e *ErrParseSpec) Error() string
  • func (e *ErrParseSpec) Unwrap() error
• type ErrUnsupportedContentTypes
  • func (e *ErrUnsupportedContentTypes) Error() string
• type FileSystem
• type Filters
• type Generator
  • func NewGenerator(spec *ogen.Spec, opts Options) (*Generator, error)
  • func (g *Generator) API() *openapi.API
  • func (g *Generator) Types() map[string]*ir.Type
  • func (g *Generator) WriteSource(fs FileSystem, pkgName string) error
• type MethodRoute
  • func (m *MethodRoute) Add(r Route) error
• type Options
• type ResponseElem
• type Route
• type RouteNode
  • func (n *RouteNode) Children() []*RouteNode
  • func (n *RouteNode) Head() byte
  • func (n *RouteNode) IsLeaf() bool
  • func (n *RouteNode) IsParam() bool
  • func (n *RouteNode) IsStatic() bool
  • func (n *RouteNode) Operation() *ir.Operation
  • func (n *RouteNode) Param() *ir.Parameter
  • func (n *RouteNode) ParamChildren() (r []*RouteNode)
  • func (n *RouteNode) ParamName() string
  • func (n *RouteNode) Prefix() string
  • func (n *RouteNode) StaticChildren() (r []*RouteNode)
  • func (n *RouteNode) Tails() (r []byte)
• type RouteTree
  • func (t *RouteTree) Walk(cb func(level int, n *RouteNode))
• type Router
  • func (s *Router) Add(r Route) error
• type RouterElem
• type TemplateConfig
  • func (t TemplateConfig) RatStrings() []string
  • func (t TemplateConfig) RegexStrings() []string
  • func (t TemplateConfig) SkipTest(typ *ir.Type) bool

Functions

func GenerateSchema

func GenerateSchema(input []byte, fs FileSystem, typeName, fileName, pkgName string) error

GenerateSchema generates type, validation and JSON encoding for given schema.

func TypeFormatMapping

func TypeFormatMapping() map[jsonschema.SchemaType]map[string]ir.PrimitiveType

Types

type DefaultElem

type DefaultElem struct {
	// Type is type of this DefaultElem.
	Type *ir.Type
	// Var is decoding/encoding variable Go name (obj) or selector (obj.Field).
	Var string
	// Default is default value to set.
	Default ir.Default
}

DefaultElem is variable helper for setting default values.

type Elem

type Elem struct {
	// Sub whether this Elem has parent Elem.
	Sub bool
	// Type is type of this Elem.
	Type *ir.Type
	// Var is decoding/encoding variable Go name (obj) or selector (obj.Field).
	Var string
	// Tag contains info about field tags, if any.
	Tag ir.Tag
	// First whether this field is first.
	First bool
}

Elem is variable helper for recursive array or object encoding or decoding.

func (Elem) NextVar

func (e Elem) NextVar() string

NextVar returns name of variable for decoding recursive call.

Needed to make variable names unique.

type ErrBuildRouter

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

ErrBuildRouter reports that route tree building failed.

func (*ErrBuildRouter) Error

func (e *ErrBuildRouter) Error() string

Error implements error.

func (*ErrBuildRouter) Unwrap

func (e *ErrBuildRouter) Unwrap() error

Unwrap implements errors.Wrapper.

type ErrNotImplemented

type ErrNotImplemented struct {
	Name string
}

ErrNotImplemented reports that feature is not implemented.

func (*ErrNotImplemented) Error

func (e *ErrNotImplemented) Error() string

Error implements error.

type ErrParseSpec

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

ErrParseSpec reports that specification parsing failed.

func (*ErrParseSpec) Error

func (e *ErrParseSpec) Error() string

Error implements error.

func (*ErrParseSpec) Unwrap

func (e *ErrParseSpec) Unwrap() error

Unwrap implements errors.Wrapper.

type ErrUnsupportedContentTypes

type ErrUnsupportedContentTypes struct {
	ContentTypes []string
}

ErrUnsupportedContentTypes reports that ogen does not support such content-type(s).

func (*ErrUnsupportedContentTypes) Error

func (e *ErrUnsupportedContentTypes) Error() string

Error implements error.

type FileSystem

type FileSystem interface {
	WriteFile(baseName string, source []byte) error
}

FileSystem represents a directory of generated package.

type Filters

type Filters struct {
	PathRegex *regexp.Regexp
	Methods   []string
}

Filters contains filters to skip operations.

type Generator

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

Generator is OpenAPI-to-Go generator.

func NewGenerator

func NewGenerator(spec *ogen.Spec, opts Options) (*Generator, error)

NewGenerator creates new Generator.

func (*Generator) API

func (g *Generator) API() *openapi.API

API returns api schema.

func (*Generator) Types

func (g *Generator) Types() map[string]*ir.Type

Types returns generated types.

func (*Generator) WriteSource

func (g *Generator) WriteSource(fs FileSystem, pkgName string) error

WriteSource writes generated definitions to fs.

type MethodRoute

type MethodRoute struct {
	Method string
	Tree   RouteTree
}

MethodRoute is route for one Method.

func (*MethodRoute) Add

func (m *MethodRoute) Add(r Route) error

Add adds route to this tree.

type Options

type Options struct {
	// VerboseRoute whether to print routes.
	VerboseRoute bool
	// GenerateExampleTests whether to generate decoding tests using schema examples.
	GenerateExampleTests bool
	// SkipTestRegex is regex to skip generated tests.
	SkipTestRegex *regexp.Regexp
	// SkipUnimplemented disables generation of unimplemented Handler, like UnimplementedServer generated by gRPC.
	SkipUnimplemented bool
	// InferSchemaType enables type inference for schemas. Schema parser will try to detect schema type
	// by its properties.
	InferSchemaType bool
	// Filters contains filters to skip operations.
	Filters Filters
	// IgnoreNotImplemented contains ErrNotImplemented messages to ignore.
	IgnoreNotImplemented []string
	// NotImplementedHook is hook for ErrNotImplemented errors.
	NotImplementedHook func(name string, err error)
}

Options is Generator options.

type ResponseElem

type ResponseElem struct {
	Response *ir.StatusResponse
	Ptr      bool
}

type Route

type Route struct {
	Method    string        // GET, POST, DELETE
	Operation *ir.Operation // getUserInfo
	Path      string        // /api/v1/user/{name}/info
}

type RouteNode

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

RouteNode is node of Radix tree of routes.

func (*RouteNode) Children

func (n *RouteNode) Children() []*RouteNode

Children returns child nodes.

func (*RouteNode) Head

func (n *RouteNode) Head() byte

Head returns first byte of prefix.

func (*RouteNode) IsLeaf

func (n *RouteNode) IsLeaf() bool

IsLeaf whether node has no children.

func (*RouteNode) IsParam

func (n *RouteNode) IsParam() bool

IsParam whether node is a parameter node.

func (*RouteNode) IsStatic

func (n *RouteNode) IsStatic() bool

IsStatic whether node is not a parameter node.

func (*RouteNode) Operation

func (n *RouteNode) Operation() *ir.Operation

Operation returns associated operation.

func (*RouteNode) Param

func (n *RouteNode) Param() *ir.Parameter

Param returns associated parameter, if any.

May be nil.

func (*RouteNode) ParamChildren

func (n *RouteNode) ParamChildren() (r []*RouteNode)

ParamChildren returns slice of child parameter nodes.

func (*RouteNode) ParamName

func (n *RouteNode) ParamName() string

ParamName returns parameter name, if any.

func (*RouteNode) Prefix

func (n *RouteNode) Prefix() string

Prefix returns common prefix.

func (*RouteNode) StaticChildren

func (n *RouteNode) StaticChildren() (r []*RouteNode)

StaticChildren returns slice of child static nodes.

func (*RouteNode) Tails

func (n *RouteNode) Tails() (r []byte)

Tails returns heads of child nodes.

Used for matching end of parameter node between two static.

type RouteTree

type RouteTree struct {
	Root *RouteNode
}

RouteTree is Radix tree of routes.

func (*RouteTree) Walk

func (t *RouteTree) Walk(cb func(level int, n *RouteNode))

type Router

type Router struct {
	Methods []MethodRoute
	// MaxParametersCount is maximum number of path parameters in one operation.
	MaxParametersCount int
}

Router contains list of routes.

func (*Router) Add

func (s *Router) Add(r Route) error

Add adds new route.

type RouterElem

type RouterElem struct {
	// ParameterIndex is index of parameter of this route part.
	ParameterIndex int
	Route          *RouteNode
}

RouterElem is variable helper for router generation.

type TemplateConfig

type TemplateConfig struct {
	Package    string
	Operations []*ir.Operation
	Types      map[string]*ir.Type
	Interfaces map[string]*ir.Type
	Error      *ir.StatusResponse
	ErrorType  *ir.Type
	Securities map[string]*ir.Security
	Router     Router
	// contains filtered or unexported fields
}

func (TemplateConfig) RatStrings

func (t TemplateConfig) RatStrings() []string

RatStrings returns slice of all unique big.Rat (multipleOf validation).

func (TemplateConfig) RegexStrings

func (t TemplateConfig) RegexStrings() []string

RegexStrings returns slice of all unique regex validators.

func (TemplateConfig) SkipTest

func (t TemplateConfig) SkipTest(typ *ir.Type) bool

SkipTest returns true, if test should be skipped.