mux

Documentation

Overview

Package mux provides some basic implementations for building routers based on net/http mux

Index

• Constants
• Variables
• func DebugHandler(logger log.Logger) http.HandlerFunc
• func DefaultEngine() *engine
• func DefaultFactory(pf proxy.Factory, logger log.Logger) route.Factory
• func HealthHandler(w http.ResponseWriter, r *http.Request)
• func NewFactory(cfg Config) route.Factory
• func NoopParamExtractor(_ *http.Request) map[string]string
• func RegisterRender(name string, r Render)
• type Config
• type Engine
• type HTTPErrorInterceptor
  • func NewHTTPErrorInterceptor(w http.ResponseWriter) *HTTPErrorInterceptor
  • func (i *HTTPErrorInterceptor) WriteHeader(code int)
• type HandlerFactory
  • func CustomEndpointHandler(rb RequestBuilder) HandlerFactory
  • func CustomEndpointHandlerWithHTTPError(rb RequestBuilder, errF server.ToHTTPError) HandlerFactory
• type HandlerMiddleware
• type ParamExtractor
• type Render
• type RequestBuilder
  • func NewRequestBuilder(paramExtractor ParamExtractor) RequestBuilder
• type RunServerFunc

Constants

const DefaultDebugPattern = "/__debug/"

const NEGOTIATE = "negotiate"

Variables

var EndpointHandler = CustomEndpointHandler(NewRequest)

var NewRequest = NewRequestBuilder(NoopParamExtractor)

Functions

func DebugHandler

func DebugHandler(logger log.Logger) http.HandlerFunc

func DefaultEngine

func DefaultEngine() *engine

func DefaultFactory

func DefaultFactory(pf proxy.Factory, logger log.Logger) route.Factory

func HealthHandler

func HealthHandler(w http.ResponseWriter, r *http.Request)

func NewFactory

func NewFactory(cfg Config) route.Factory

func NoopParamExtractor

func NoopParamExtractor(_ *http.Request) map[string]string

func RegisterRender

func RegisterRender(name string, r Render)

Types

type Config

type Config struct {
	Engine         Engine
	Middlewares    []HandlerMiddleware
	HandlerFactory HandlerFactory
	ProxyFactory   proxy.Factory
	Logger         log.Logger
	DebugPattern   string
	RunServer      RunServerFunc
}

type Engine

type Engine interface {
	http.Handler
	Handle(pattern, method string, handler http.Handler)
}

type HTTPErrorInterceptor

type HTTPErrorInterceptor struct {
	http.ResponseWriter
	// contains filtered or unexported fields
}

func NewHTTPErrorInterceptor

func NewHTTPErrorInterceptor(w http.ResponseWriter) *HTTPErrorInterceptor

func (*HTTPErrorInterceptor) WriteHeader

func (i *HTTPErrorInterceptor) WriteHeader(code int)

type HandlerFactory

type HandlerFactory func(*config.EndpointConfig, proxy.Proxy) http.HandlerFunc

func CustomEndpointHandler

func CustomEndpointHandler(rb RequestBuilder) HandlerFactory

func CustomEndpointHandlerWithHTTPError

func CustomEndpointHandlerWithHTTPError(rb RequestBuilder, errF server.ToHTTPError) HandlerFactory

type HandlerMiddleware

type HandlerMiddleware interface {
	Handler(h http.Handler) http.Handler
}

type ParamExtractor

type ParamExtractor func(r *http.Request) map[string]string

type Render

type Render func(http.ResponseWriter, *proxy.Response)

type RequestBuilder

type RequestBuilder func(r *http.Request, queryString, headersToSend []string) *proxy.Request

func NewRequestBuilder

func NewRequestBuilder(paramExtractor ParamExtractor) RequestBuilder

type RunServerFunc

type RunServerFunc func(context.Context, config.ServiceConfig, http.Handler) error