reflectopenapi

Aug 24, 2023

Changes in this version

type Config

+ DefaultErrorExample interface{}

+ EnableAutoTag bool

+ Fset *token.FileSet

+ GoPositionFunc func(*token.FileSet, *shape.Func) string

+ Info *info.Info

+ type Header struct

+ Description string

+ Example string

+ Name string

type Manager

+ func (m *Manager) RegisterFuncText(fn interface{}, contentType string, modifiers ...func(*openapi3.Operation)) *RegisterFuncAction

type RegisterFuncAction

+ func (a *RegisterFuncAction) AnotherError(code int, value interface{}, description string) *RegisterFuncAction

+ func (a *RegisterFuncAction) Error(value interface{}, description string) *RegisterFuncAction

+ func (a *RegisterFuncAction) Headers(values ...Header) *RegisterFuncAction

+ func (a *RegisterFuncAction) Tags(tags ...string) *RegisterFuncAction

type TagNameOption

+ RequiredTag string

type Transformer

+ Fset *token.FileSet

+ GoPositionFunc func(fset *token.FileSet, fn *shape.Func) string

type Visitor

+ EnableAutoTag bool

Feb 2, 2023

Changes in this version

+ var FORCE bool

type Config

+ DisableInputRef bool

+ DisableOutputRef bool

+ type Direction string

+ const DirectionInput

+ const DirectionInternal

+ const DirectionOutput

+ const DirectionParameter

type RegisterFuncAction

+ func (a *RegisterFuncAction) Before(f func(*shape.Func)) *RegisterFuncAction

+ func (a *RegisterFuncAction) DefaultInput(value interface{}) *RegisterFuncAction

type UseRefResolver

+ DisableInputRef bool

+ DisableOutputRef bool

Jan 29, 2023

Changes in this version

type Config

+ Loaded bool

type Manager

+ func (m *Manager) RegisterInterception(rt reflect.Type, intercept func(*shape.Shape) *openapi3.Schema)

type MergeParamsInputSelector

+ func (s *MergeParamsInputSelector) NeedTransformer(t *Transformer)

+ type TagNameOption struct

+ DescriptionTag string

+ NameTag string

+ OverrideTag string

+ ParamTypeTag string

+ XNewTypeTag string

+ func DefaultTagNameOption() *TagNameOption

type Transformer

+ Extractor Extractor

+ TagNameOption TagNameOption

Jul 18, 2022

Changes in this version

type RegisterFuncAction

+ func (a *RegisterFuncAction) Description(description string) *RegisterFuncAction

+ func (a *RegisterFuncAction) Example(code int, mime string, title string, value interface{}) *RegisterFuncAction

+ func (a *RegisterFuncAction) Status(code int) *RegisterFuncAction

type RegisterTypeAction

+ func (a *RegisterTypeAction) Before(f func(*openapi3.Schema)) *RegisterTypeAction

+ func (a *RegisterTypeAction) Default(value interface{}) *RegisterTypeAction

+ func (a *RegisterTypeAction) Description(description string) *RegisterTypeAction

+ func (a *RegisterTypeAction) Enum(values ...interface{}) *RegisterTypeAction

+ func (a *RegisterTypeAction) Example(value interface{}) *RegisterTypeAction

Dec 1, 2021

Changes in this version

type Config

+ func (c *Config) NewManager() (*Manager, func(ctx context.Context) error, error)

Jun 16, 2021

Changes in this version

type Binder

+ BindSchemas func(doc *openapi3.T)

type Manager

+ Actions []*registerAction

+ func (m *Manager) RegisterFunc(fn interface{}, modifiers ...func(*openapi3.Operation)) *RegisterFuncAction

+ func (m *Manager) RegisterType(ob interface{}, modifiers ...func(*openapi3.Schema)) *RegisterTypeAction

+ type NameStore struct

+ OnConflict func(*RefPair, int)

+ Prefix string

+ func NewNameStore() *NameStore

+ func (ns *NameStore) BindSchemas(doc *openapi3.T)

+ func (ns *NameStore) GetOrCreatePair(v *openapi3.Schema, name string, shape shape.Shape) *RefPair

+ type RefPair struct

+ Def *openapi3.SchemaRef

+ Name string

+ Ref *openapi3.SchemaRef

+ Shape shape.Shape

+ type RegisterFuncAction struct

+ func (a *RegisterFuncAction) After(f func(*openapi3.Operation)) *RegisterFuncAction

+ type RegisterTypeAction struct

+ func (a *RegisterTypeAction) After(f func(*openapi3.SchemaRef)) *RegisterTypeAction

Dec 9, 2020

Changes in this version

type Config

+ Extractor Extractor

+ Selector Selector

+ func (c *Config) DefaultExtractor() Extractor

+ func (c *Config) DefaultResolver() Resolver

+ func (c *Config) DefaultSelector() Selector

+ type DefaultSelector struct

+ type Extractor interface

+ Extract func(interface{}) shape.Shape

+ type FirstParamInputSelector struct

+ func (s *FirstParamInputSelector) SelectInput(fn shape.Function) shape.Shape

+ type FirstParamOutputSelector struct

+ func (s *FirstParamOutputSelector) SelectOutput(fn shape.Function) shape.Shape

+ type MergeParamsInputSelector struct

+ func (s *MergeParamsInputSelector) SelectInput(fn shape.Function) shape.Shape

+ type Selector interface

+ SelectInput func(shape.Function) shape.Shape

+ SelectOutput func(shape.Function) shape.Shape

type Transformer

+ Selector Selector

Oct 10, 2020

Changes in this version

type Config

+ DefaultError interface{}

+ SkipExtractComments bool

+ func (c *Config) EmitDoc(ctx context.Context, use func(m *Manager)) error

type Visitor

+ CommentLookup *comment.Lookup

Oct 3, 2020

Changes in this version

+ type Config struct

+ Doc *openapi3.Swagger

+ IsRequiredCheckFunction func(reflect.StructTag) bool

+ Resolver Resolver

+ SkipValidation bool

+ StrictSchema bool

+ func (c *Config) BuildDoc(ctx context.Context, use func(m *Manager)) (*openapi3.Swagger, error)

+ type Manager struct

+ Doc *openapi3.Swagger

+ Resolver Resolver

+ Visitor *Visitor

type NoRefResolver

+ AdditionalPropertiesAllowed *bool

type Transformer

+ IsRequired func(reflect.StructTag) bool

+ func (t *Transformer) RegisterInterception(rt reflect.Type, intercept func(shape.Shape) *openapi3.Schema)

type UseRefResolver

+ AdditionalPropertiesAllowed *bool

Oct 3, 2020

Changes in this version

+ func NewDoc() (*openapi3.Swagger, error)

+ func NewDocFromSkeleton(skeleton []byte) (*openapi3.Swagger, error)

+ type Binder interface

+ Bind func(doc *openapi3.Swagger)

+ type NoRefResolver struct

+ func (r *NoRefResolver) Bind(doc *openapi3.Swagger)

+ func (r *NoRefResolver) ResolveParameter(v *openapi3.Parameter, s shape.Shape) *openapi3.ParameterRef

+ func (r *NoRefResolver) ResolveRequestBody(v *openapi3.RequestBody, s shape.Shape) *openapi3.RequestBodyRef

+ func (r *NoRefResolver) ResolveResponse(v *openapi3.Response, s shape.Shape) *openapi3.ResponseRef

+ func (r *NoRefResolver) ResolveSchema(v *openapi3.Schema, s shape.Shape) *openapi3.SchemaRef

+ type Resolver interface

+ ResolveParameter func(v *openapi3.Parameter, s shape.Shape) *openapi3.ParameterRef

+ ResolveRequestBody func(v *openapi3.RequestBody, s shape.Shape) *openapi3.RequestBodyRef

+ ResolveResponse func(v *openapi3.Response, s shape.Shape) *openapi3.ResponseRef

+ ResolveSchema func(v *openapi3.Schema, s shape.Shape) *openapi3.SchemaRef

+ type Transformer struct

+ CacheHit int

+ func (t *Transformer) Builtin() *Transformer

+ func (t *Transformer) Transform(s shape.Shape) interface{}

+ type UseRefResolver struct

+ Schemas []*openapi3.SchemaRef

+ func (r *UseRefResolver) Bind(doc *openapi3.Swagger)

+ func (r *UseRefResolver) ResolveParameter(v *openapi3.Parameter, s shape.Shape) *openapi3.ParameterRef

+ func (r *UseRefResolver) ResolveRequestBody(v *openapi3.RequestBody, s shape.Shape) *openapi3.RequestBodyRef

+ func (r *UseRefResolver) ResolveResponse(v *openapi3.Response, s shape.Shape) *openapi3.ResponseRef

+ func (r *UseRefResolver) ResolveSchema(v *openapi3.Schema, s shape.Shape) *openapi3.SchemaRef

+ type Visitor struct

+ Doc *openapi3.Swagger

+ Operations map[reflect.Type]*openapi3.Operation

+ Schemas map[reflect.Type]*openapi3.Schema

+ func NewVisitor(resolver Resolver) *Visitor

+ func (v *Visitor) VisitFunc(ob interface{}, modifiers ...func(*openapi3.Operation)) *openapi3.Operation

+ func (v *Visitor) VisitType(ob interface{}, modifiers ...func(*openapi3.Schema)) *openapi3.SchemaRef