Documentation
¶
Overview ¶
Package mux provides some basic implementations for building routers based on net/http mux
Index ¶
- Constants
- Variables
- func DebugHandler(logger logging.Logger) http.HandlerFunc
- func DefaultEngine() *http.ServeMux
- func DefaultFactory(pf proxy.Factory, logger logging.Logger) router.Factory
- func NewFactory(cfg Config) router.Factory
- type Config
- type Engine
- type HandlerFactory
- type HandlerMiddleware
- type ParamExtractor
- type RequestBuilder
Constants ¶
const DefaultDebugPattern = "/__debug/"
DefaultDebugPattern is the default pattern used to define the debug endpoint
Variables ¶
var EndpointHandler = CustomEndpointHandler(NewRequest)
EndpointHandler is a HandlerFactory that adapts the mux router with the injected proxy and the default RequestBuilder
var ErrInternalError = errors.New("internal server error")
ErrInternalError is the error returned by the router when something went wrong
var NewRequest = NewRequestBuilder(func(r *http.Request) map[string]string { return map[string]string{} })
NewRequest is a RequestBuilder that creates a proxy request from the received http request without processing the uri params
Functions ¶
func DebugHandler ¶
func DebugHandler(logger logging.Logger) http.HandlerFunc
DebugHandler creates a dummy handler function, useful for quick integration tests
func DefaultEngine ¶
DefaultEngine returns a new engine using the http.ServeMux router
func DefaultFactory ¶
DefaultFactory returns a net/http mux router factory with the injected proxy factory and logger
func NewFactory ¶
NewFactory returns a net/http mux router factory with the injected configuration
Types ¶
type Config ¶
type Config struct {
Engine Engine
Middlewares []HandlerMiddleware
HandlerFactory HandlerFactory
ProxyFactory proxy.Factory
Logger logging.Logger
DebugPattern string
}
Config is the struct that collects the parts the router should be builded from
type HandlerFactory ¶
type HandlerFactory func(*config.EndpointConfig, proxy.Proxy) http.HandlerFunc
HandlerFactory creates a handler function that adapts the mux router with the injected proxy
func CustomEndpointHandler ¶
func CustomEndpointHandler(rb RequestBuilder) HandlerFactory
CustomEndpointHandler returns a HandlerFactory with the received RequestBuilder
type HandlerMiddleware ¶
HandlerMiddleware is the interface for the decorators over the http.Handler
type ParamExtractor ¶
ParamExtractor is a function that extracts thes query params from the requested uri
type RequestBuilder ¶
RequestBuilder is a function that creates a proxy.Request from the received http request
func NewRequestBuilder ¶
func NewRequestBuilder(paramExtractor ParamExtractor) RequestBuilder
NewRequestBuilder gets a RequestBuilder with the received ParamExtractor as a query param extraction mecanism
Source Files