httpsrv

Documentation

Index

• func Feature(config ...func(*Installer)) miruken.Feature
• func Pipeline(handler miruken.Handler, middleware ...Middleware) http.Handler
• type ApiHandler
  • func (a *ApiHandler) Constructor(_ *struct{ args.Optional }, logger logr.Logger)
  • func (a *ApiHandler) ServeHTTP(w http.ResponseWriter, r *http.Request, h miruken.Handler)
• type Installer
  • func (i *Installer) DependsOn() []miruken.Feature
  • func (i *Installer) Install(setup *miruken.SetupBuilder) error
• type Middleware
• type MiddlewareFunc
  • func (f MiddlewareFunc) ServeHTTP(w http.ResponseWriter, r *http.Request, h miruken.Handler, m Middleware, ...)
• type StatusCodeMapper
  • func (s *StatusCodeMapper) AccessDenied(_ ..., _ *authorizes.AccessDeniedError) int
  • func (s *StatusCodeMapper) JsonSyntax(_ ..., _ *json.SyntaxError) int
  • func (s *StatusCodeMapper) NotHandled(_ ..., _ *miruken.NotHandledError) int
  • func (s *StatusCodeMapper) UnknownTypeId(_ ..., _ *api.UnknownTypeIdError) int
  • func (s *StatusCodeMapper) Validation(_ ..., _ *validates.Outcome) int

Functions

func Feature

func Feature(config ...func(*Installer)) miruken.Feature

Feature configures http server support

func Pipeline

func Pipeline(
	handler miruken.Handler,
	middleware ...Middleware,
) http.Handler

Pipeline returns a http.Handler for processing api calls through a list of Middleware components.

Types

type ApiHandler

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

ApiHandler is an http.Handler for processing api requests over http.

func (*ApiHandler) Constructor

func (a *ApiHandler) Constructor(
	_ *struct{ args.Optional }, logger logr.Logger,
)

func (*ApiHandler) ServeHTTP

func (a *ApiHandler) ServeHTTP(
	w http.ResponseWriter,
	r *http.Request,
	h miruken.Handler,
)

type Installer

type Installer struct{}

Installer configures http server support

func (*Installer) DependsOn

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

func (*Installer) Install

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

type Middleware

type Middleware interface {
	ServeHTTP(
		w http.ResponseWriter,
		r *http.Request,
		h miruken.Handler,
		m Middleware,
		n func(miruken.Handler),
	)
}

Middleware extends http.Handler to include a request scoped context.

type MiddlewareFunc

type MiddlewareFunc func(
	w http.ResponseWriter,
	r *http.Request,
	h miruken.Handler,
	m Middleware,
	n func(miruken.Handler),
)

MiddlewareFunc promotes a function to Middleware.

func (MiddlewareFunc) ServeHTTP

func (f MiddlewareFunc) ServeHTTP(
	w http.ResponseWriter,
	r *http.Request,
	h miruken.Handler,
	m Middleware,
	n func(miruken.Handler),
)

type StatusCodeMapper

type StatusCodeMapper struct{}

StatusCodeMapper maps errors into a corresponding http status code.

func (*StatusCodeMapper) AccessDenied

func (s *StatusCodeMapper) AccessDenied(
	_ *struct {
		maps.It
		maps.Format `to:"http:status-code"`
	}, _ *authorizes.AccessDeniedError,
) int

func (*StatusCodeMapper) JsonSyntax

func (s *StatusCodeMapper) JsonSyntax(
	_ *struct {
		maps.It
		maps.Format `to:"http:status-code"`
	}, _ *json.SyntaxError,
) int

func (*StatusCodeMapper) NotHandled

func (s *StatusCodeMapper) NotHandled(
	_ *struct {
		maps.It
		maps.Format `to:"http:status-code"`
	}, _ *miruken.NotHandledError,
) int

func (*StatusCodeMapper) UnknownTypeId

func (s *StatusCodeMapper) UnknownTypeId(
	_ *struct {
		maps.It
		maps.Format `to:"http:status-code"`
	}, _ *api.UnknownTypeIdError,
) int

func (*StatusCodeMapper) Validation

func (s *StatusCodeMapper) Validation(
	_ *struct {
		maps.It
		maps.Format `to:"http:status-code"`
	}, _ *validates.Outcome,
) int