openapi

Documentation

Index

• func ExtraComponents(components ...any) func(*Installer)
• func Handler(docs map[string]*openapi3.T, enableCors bool) http.HandlerFunc
• func Surrogates(surrogates map[reflect.Type]any) func(*Installer)
• type Installer
  • func Feature(base openapi3.T, config ...func(*Installer)) *Installer
  • func (i *Installer) AfterInstall(_ *miruken.SetupBuilder, handler miruken.Handler) error
  • func (i *Installer) BindingCreated(policy miruken.Policy, descriptor *miruken.HandlerDescriptor, ...)
  • func (i *Installer) DependsOn() []miruken.Feature
  • func (i *Installer) DescriptorCreated(_ *miruken.HandlerDescriptor)
  • func (i *Installer) Docs() map[string]*openapi3.T
  • func (i *Installer) Install(setup *miruken.SetupBuilder) error

Functions

func ExtraComponents

func ExtraComponents(components ...any) func(*Installer)

ExtraComponents provides additional components to include schemas for.

func Handler

func Handler(docs map[string]*openapi3.T, enableCors bool) http.HandlerFunc

func Surrogates

func Surrogates(surrogates map[reflect.Type]any) func(*Installer)

Types

type Installer

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

Installer configures openapi support.

func Feature

func Feature(
	base openapi3.T,
	config ...func(*Installer),
) *Installer

Feature configures http server support

func (*Installer) AfterInstall

func (i *Installer) AfterInstall(
	_ *miruken.SetupBuilder,
	handler miruken.Handler,
) error

func (*Installer) BindingCreated

func (i *Installer) BindingCreated(
	policy miruken.Policy,
	descriptor *miruken.HandlerDescriptor,
	binding miruken.Binding,
)

func (*Installer) DependsOn

func (i *Installer) DependsOn() []miruken.Feature

func (*Installer) DescriptorCreated

func (i *Installer) DescriptorCreated(
	_ *miruken.HandlerDescriptor,
)

func (*Installer) Docs

func (i *Installer) Docs() map[string]*openapi3.T

func (*Installer) Install

func (i *Installer) Install(setup *miruken.SetupBuilder) error