restserver

Documentation

Index

• Variables
• func HTTPMiddlewareCORS(allowMethods, allowHeaders, allowOrigins []string, exposeHeaders []string, ...) func(http.Handler) http.Handler
• func HTTPMiddlewareTracer() func(http.Handler) http.Handler
• func NewServer(service factory.ServiceFactory, opts ...OptionFunc) factory.AppServerFactory
• func WithChainingMiddlewares(handlerFunc http.HandlerFunc, middlewares ...func(http.Handler) http.Handler) http.HandlerFunc
• type OptionFunc
  • func AddGraphQLOption(opts ...graphqlserver.OptionFunc) OptionFunc
  • func AddMountRouter(fn func(interfaces.RESTRouter)) OptionFunc
  • func AddRootMiddlewares(middlewares ...func(http.Handler) http.Handler) OptionFunc
  • func SetDebugMode(debugMode bool) OptionFunc
  • func SetDisableTrace() OptionFunc
  • func SetHTTPPort(port uint16) OptionFunc
  • func SetIncludeGraphQL(includeGraphQL bool) OptionFunc
  • func SetJaegerMaxPacketSize(max int) OptionFunc
  • func SetRootHTTPHandler(rootHandler http.HandlerFunc) OptionFunc
  • func SetRootMiddlewares(middlewares ...func(http.Handler) http.Handler) OptionFunc
  • func SetRootPath(rootPath string) OptionFunc
  • func SetSharedListener(sharedListener cmux.CMux) OptionFunc
  • func SetTLSConfig(tlsConfig *tls.Config) OptionFunc

Variables

var (
	MiddlewareExcludeURLPath = map[string]struct{}{"/": {}, "/graphql": {}, "/favicon.ico": {}}
)

var URLParam = func(r *http.Request, key string) string {
	return chi.URLParam(r, key)
}

URLParam default parse param from url path

Functions

func HTTPMiddlewareCORS

func HTTPMiddlewareCORS(
	allowMethods, allowHeaders, allowOrigins []string,
	exposeHeaders []string,
	allowCredential bool,
) func(http.Handler) http.Handler

HTTPMiddlewareCORS middleware for cors

func HTTPMiddlewareTracer

func HTTPMiddlewareTracer() func(http.Handler) http.Handler

HTTPMiddlewareTracer middleware wrapper for tracer

func NewServer

func NewServer(service factory.ServiceFactory, opts ...OptionFunc) factory.AppServerFactory

NewServer create new REST server

func WithChainingMiddlewares

func WithChainingMiddlewares(handlerFunc http.HandlerFunc, middlewares ...func(http.Handler) http.Handler) http.HandlerFunc

WithChainingMiddlewares chaining middlewares

Types

type OptionFunc

type OptionFunc func(*option)

OptionFunc type

func AddGraphQLOption

func AddGraphQLOption(opts ...graphqlserver.OptionFunc) OptionFunc

AddGraphQLOption option func

func AddMountRouter

func AddMountRouter(fn func(interfaces.RESTRouter)) OptionFunc

AddMountRouter option func

func AddRootMiddlewares

func AddRootMiddlewares(middlewares ...func(http.Handler) http.Handler) OptionFunc

AddRootMiddlewares option func, overide root middleware

func SetDebugMode

func SetDebugMode(debugMode bool) OptionFunc

SetDebugMode option func

func SetDisableTrace

func SetDisableTrace() OptionFunc

SetDisableTrace option func

func SetHTTPPort

func SetHTTPPort(port uint16) OptionFunc

SetHTTPPort option func

func SetIncludeGraphQL

func SetIncludeGraphQL(includeGraphQL bool) OptionFunc

SetIncludeGraphQL option func

func SetJaegerMaxPacketSize

func SetJaegerMaxPacketSize(max int) OptionFunc

SetJaegerMaxPacketSize option func

func SetRootHTTPHandler

func SetRootHTTPHandler(rootHandler http.HandlerFunc) OptionFunc

SetRootHTTPHandler option func

func SetRootMiddlewares

func SetRootMiddlewares(middlewares ...func(http.Handler) http.Handler) OptionFunc

SetRootMiddlewares option func

func SetRootPath

func SetRootPath(rootPath string) OptionFunc

SetRootPath option func

func SetSharedListener

func SetSharedListener(sharedListener cmux.CMux) OptionFunc

SetSharedListener option func

func SetTLSConfig

func SetTLSConfig(tlsConfig *tls.Config) OptionFunc

SetTLSConfig option func