api

Documentation

Index

• type DefaultModule
• type Endpoint
• type Middleware
• type MiddlewareFunc
  • func (m MiddlewareFunc) Handle(h http.Handler) http.Handler
• type Module
• type SkipDefaultMiddlewaresExt
• type SkipMiddlewaresExt
• type WebService

Types

type DefaultModule

type DefaultModule interface {
	Default() bool
}

DefaultModule is extension to Module that specify whether is default loaded TODO: consider more proper interface that can be customized its behaviour inside the framework

type Endpoint

type Endpoint struct {
	Middlewares []Middleware
	Path        string
	Method      string
	Handler     http.Handler
}

type Middleware

type Middleware interface {
	Handle(h http.Handler) http.Handler
}

type MiddlewareFunc

type MiddlewareFunc func(h http.Handler) http.Handler

func (MiddlewareFunc) Handle

func (m MiddlewareFunc) Handle(h http.Handler) http.Handler

type Module

type Module interface {
	Init(ctx context.Context, config config.Config) error
	Close(ctx context.Context) error
}

type SkipDefaultMiddlewaresExt

type SkipDefaultMiddlewaresExt interface {
	SkipDefaultMiddlewares() bool
}

type SkipMiddlewaresExt

type SkipMiddlewaresExt interface {
	SkipMiddlewares() bool
}

type WebService

type WebService interface {
	CreateEndpoints(middlewares ...Middleware) []Endpoint
}