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 Config
  • func (c *Config) ScopeMap() map[string]string
  • func (c *Config) ScopeNames() []string
• type Installer
  • func Feature(base *openapi3.T, config ...func(*Installer)) *Installer
  • func (i *Installer) AfterInstall(_ *setup.Builder, handler miruken.Handler) error
  • func (i *Installer) BindingCreated(policy miruken.Policy, handlerInfo *miruken.HandlerInfo, ...)
  • func (i *Installer) DependsOn() []setup.Feature
  • func (i *Installer) Docs() map[string]*openapi3.T
  • func (i *Installer) HandlerInfoCreated(_ *miruken.HandlerInfo)
  • func (i *Installer) Install(b *setup.Builder) 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 Config

type Config struct {
	AuthorizationUrl string
	TokenUrl         string
	ClientId         string
	Scopes           []struct {
		Name        string
		Description string
	}
	OpenIdConnectUrl string
}

Config defines the configuration for openapi/swagger support.

func (*Config) ScopeMap

func (c *Config) ScopeMap() map[string]string

func (*Config) ScopeNames

func (c *Config) ScopeNames() []string

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(
	_ *setup.Builder,
	handler miruken.Handler,
) error

func (*Installer) BindingCreated

func (i *Installer) BindingCreated(
	policy miruken.Policy,
	handlerInfo *miruken.HandlerInfo,
	binding miruken.Binding,
)

func (*Installer) DependsOn

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

func (*Installer) Docs

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

func (*Installer) HandlerInfoCreated

func (i *Installer) HandlerInfoCreated(
	_ *miruken.HandlerInfo,
)

func (*Installer) Install

func (i *Installer) Install(b *setup.Builder) error