compiler

package

v0.0.0-...-a037c27 Latest Latest Go to latest Published: Mar 9, 2019 License: MIT Imports: 15 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/lestrrat-go/openapi

Links

Open Source Insights

Documentation ¶

Index ¶

type Array
- func (a *Array) Elem() string
- func (a *Array) Name() string
- func (a *Array) ResolveIncomplete(ctx *compileCtx) (Type, error)
- func (a *Array) SetName(s string)
type Builtin
- func (b Builtin) Name() string
- func (b Builtin) ResolveIncomplete(ctx *compileCtx) (Type, error)
- func (b Builtin) SetName(s string)
type Call
- func (call *Call) AllFields() []*Field
- func (call *Call) Body() Type
- func (call *Call) Consumes() []string
- func (call *Call) DefaultConsumes() string
- func (call *Call) Header() Type
- func (call *Call) Method() string
- func (call *Call) Name() string
- func (call *Call) Optionals() []*Field
- func (call *Call) Path() Type
- func (call *Call) Query() Type
- func (call *Call) RequestPath() string
- func (call *Call) Requireds() []*Field
- func (call *Call) Responses() []*Response
- func (call *Call) SecuritySettings() []*SecuritySettings
- func (call *Call) Verb() string
type ClientDefinition
- func Compile(spec openapi.OpenAPI, defaultServiceName string) (*ClientDefinition, error)
- func (c *ClientDefinition) Definitions() map[string]TypeDefinition
- func (c *ClientDefinition) ServiceNames() []string
- func (c *ClientDefinition) Services() map[string]*Service
type Field
- func (f *Field) ContainerName() string
- func (f *Field) Hints() Hints
- func (f *Field) In() openapi.Location
- func (f *Field) Name() string
- func (f *Field) Required() bool
- func (f *Field) Type() Type
type Hints
type Incomplete
- func (v Incomplete) Name() string
- func (v Incomplete) ResolveIncomplete(ctx *compileCtx) (Type, error)
- func (v Incomplete) SetName(s string)
type Response
- func (r *Response) Code() string
- func (r *Response) Type() string
type SecuritySettings
- func (ss *SecuritySettings) Definition() openapi.SecurityScheme
- func (ss *SecuritySettings) Scopes() []string
type Service
- func (s *Service) Calls() []*Call
- func (s *Service) Name() string
type Struct
- func (s *Struct) Fields() []*Field
- func (s *Struct) Name() string
- func (v *Struct) ResolveIncomplete(ctx *compileCtx) (Type, error)
- func (v *Struct) SetName(s string)
type Type
type TypeDefinition

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Array ¶

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

func (*Array) Elem ¶

func (a *Array) Elem() string

func (*Array) Name ¶

func (a *Array) Name() string

func (*Array) ResolveIncomplete ¶

func (a *Array) ResolveIncomplete(ctx *compileCtx) (Type, error)

func (*Array) SetName ¶

func (a *Array) SetName(s string)

type Builtin ¶

type Builtin string

func (Builtin) Name ¶

func (b Builtin) Name() string

func (Builtin) ResolveIncomplete ¶

func (b Builtin) ResolveIncomplete(ctx *compileCtx) (Type, error)

func (Builtin) SetName ¶

func (b Builtin) SetName(s string)

type Call ¶

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

func (*Call) AllFields ¶

func (call *Call) AllFields() []*Field

func (*Call) Body ¶

func (call *Call) Body() Type

func (*Call) Consumes ¶

func (call *Call) Consumes() []string

func (*Call) DefaultConsumes ¶

func (call *Call) DefaultConsumes() string

func (call *Call) Header() Type

func (*Call) Method ¶

func (call *Call) Method() string

func (*Call) Name ¶

func (call *Call) Name() string

func (*Call) Optionals ¶

func (call *Call) Optionals() []*Field

func (*Call) Path ¶

func (call *Call) Path() Type

func (*Call) Query ¶

func (call *Call) Query() Type

func (*Call) RequestPath ¶

func (call *Call) RequestPath() string

func (*Call) Requireds ¶

func (call *Call) Requireds() []*Field

func (*Call) Responses ¶

func (call *Call) Responses() []*Response

func (*Call) SecuritySettings ¶

func (call *Call) SecuritySettings() []*SecuritySettings

func (*Call) Verb ¶

func (call *Call) Verb() string

type ClientDefinition ¶

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

func Compile ¶

func Compile(spec openapi.OpenAPI, defaultServiceName string) (*ClientDefinition, error)

func (*ClientDefinition) Definitions ¶

func (c *ClientDefinition) Definitions() map[string]TypeDefinition

func (*ClientDefinition) ServiceNames ¶

func (c *ClientDefinition) ServiceNames() []string

func (*ClientDefinition) Services ¶

func (c *ClientDefinition) Services() map[string]*Service

type Field ¶

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

func (*Field) ContainerName ¶

func (f *Field) ContainerName() string

func (*Field) Hints ¶

func (f *Field) Hints() Hints

func (*Field) In ¶

func (f *Field) In() openapi.Location

func (*Field) Name ¶

func (f *Field) Name() string

func (*Field) Required ¶

func (f *Field) Required() bool

func (*Field) Type ¶

func (f *Field) Type() Type

type Hints ¶

type Hints struct {
	GoName string // camelCase name
	GoTag  string
	JsName string
}

type Incomplete ¶

type Incomplete string

func (Incomplete) Name ¶

func (v Incomplete) Name() string

func (Incomplete) ResolveIncomplete ¶

func (v Incomplete) ResolveIncomplete(ctx *compileCtx) (Type, error)

func (Incomplete) SetName ¶

func (v Incomplete) SetName(s string)

type Response ¶

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

func (*Response) Code ¶

func (r *Response) Code() string

func (*Response) Type ¶

func (r *Response) Type() string

type SecuritySettings ¶

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

func (*SecuritySettings) Definition ¶

func (ss *SecuritySettings) Definition() openapi.SecurityScheme

func (*SecuritySettings) Scopes ¶

func (ss *SecuritySettings) Scopes() []string

type Service ¶

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

func (*Service) Calls ¶

func (s *Service) Calls() []*Call

func (*Service) Name ¶

func (s *Service) Name() string

type Struct ¶

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

func (*Struct) Fields ¶

func (s *Struct) Fields() []*Field

func (*Struct) Name ¶

func (s *Struct) Name() string

func (*Struct) ResolveIncomplete ¶

func (v *Struct) ResolveIncomplete(ctx *compileCtx) (Type, error)

func (*Struct) SetName ¶

func (v *Struct) SetName(s string)

type Type ¶

type Type interface {
	Name() string
	SetName(string)
	ResolveIncomplete(ctx *compileCtx) (Type, error)
}

type TypeDefinition ¶

type TypeDefinition struct {
	Path    string
	Context string
	Type    Type
}

TypeDefinition gives you the context where this type was generated

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Documentation ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

Types ¶

type Array ¶

func (*Array) Elem ¶

func (*Array) Name ¶

func (*Array) ResolveIncomplete ¶

func (*Array) SetName ¶

type Builtin ¶

func (Builtin) Name ¶

func (Builtin) ResolveIncomplete ¶

func (Builtin) SetName ¶

type Call ¶

func (*Call) AllFields ¶

func (*Call) Body ¶

func (*Call) Consumes ¶

func (*Call) DefaultConsumes ¶

func (*Call) Header ¶

func (*Call) Method ¶

func (*Call) Name ¶

func (*Call) Optionals ¶

func (*Call) Path ¶

func (*Call) Query ¶

func (*Call) RequestPath ¶

func (*Call) Requireds ¶

func (*Call) Responses ¶

func (*Call) SecuritySettings ¶

func (*Call) Verb ¶

type ClientDefinition ¶

func Compile ¶

func (*ClientDefinition) Definitions ¶

func (*ClientDefinition) ServiceNames ¶

func (*ClientDefinition) Services ¶

type Field ¶

func (*Field) ContainerName ¶

func (*Field) Hints ¶

func (*Field) In ¶

func (*Field) Name ¶

func (*Field) Required ¶

func (*Field) Type ¶

type Hints ¶

type Incomplete ¶

func (Incomplete) Name ¶

func (Incomplete) ResolveIncomplete ¶

func (Incomplete) SetName ¶

type Response ¶

func (*Response) Code ¶

func (*Response) Type ¶

type SecuritySettings ¶

func (*SecuritySettings) Definition ¶

func (*SecuritySettings) Scopes ¶

type Service ¶

func (*Service) Calls ¶

func (*Service) Name ¶

type Struct ¶

func (*Struct) Fields ¶

func (*Struct) Name ¶

func (*Struct) ResolveIncomplete ¶

func (*Struct) SetName ¶

type Type ¶

type TypeDefinition ¶

Source Files ¶