mux

Documentation

Index

• func Redirect(url string) *httpbody.HttpBody
• type MuxOption
• type MuxServe
  • func NewMuxServe(logger *zap.Logger, opts ...Optional) *MuxServe
  • func (srv *MuxServe) Handle(method, path string, h runtime.HandlerFunc)
  • func (srv *MuxServe) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (srv *MuxServe) ServeMux() *runtime.ServeMux
• type Optional
  • func WithAuthFunc(a interceptor.Authorize) Optional
  • func WithBodyMarshaler(ms runtime.Marshaler) Optional
  • func WithBodyWriter(b rewriter.BodyReWriterFunc) Optional
  • func WithErrorHandler(fn runtime.ErrorHandlerFunc) Optional
  • func WithErrorMarshaler(ms runtime.Marshaler) Optional
  • func WithLimiter(l *limit.Limiter) Optional
  • func WithMiddleWares(middleWares ...middleware.MuxMiddleware) Optional
  • func WithRunTimeOpts(opts runtime.ServeMuxOption) Optional
  • func WithTracer(tracer opentracing.Tracer) Optional
  • func WithoutHTTPStatus() Optional

Functions

func Redirect

func Redirect(url string) *httpbody.HttpBody

Redirect response http body with redirect

Types

type MuxOption

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

MuxOption

type MuxServe

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

MuxServe the custom serve mux that implement grpc MuxServe to simplify the http restful.

func NewMuxServe

func NewMuxServe(logger *zap.Logger, opts ...Optional) *MuxServe

NewMuxServe allocates and returns a new MuxServe.

func (*MuxServe) Handle

func (srv *MuxServe) Handle(method, path string, h runtime.HandlerFunc)

Handle handle http path

func (*MuxServe) ServeHTTP

func (srv *MuxServe) ServeHTTP(w http.ResponseWriter, r *http.Request)

Handle handle http path

func (*MuxServe) ServeMux

func (srv *MuxServe) ServeMux() *runtime.ServeMux

ServeMux return grpc gateway server mux

type Optional

type Optional func(*MuxOption)

Optional the Options for this module

func WithAuthFunc

func WithAuthFunc(a interceptor.Authorize) Optional

WithAuthFunc

func WithBodyMarshaler

func WithBodyMarshaler(ms runtime.Marshaler) Optional

WithBodyMarshaler

func WithBodyWriter

func WithBodyWriter(b rewriter.BodyReWriterFunc) Optional

WithBodyWriter

func WithErrorHandler

func WithErrorHandler(fn runtime.ErrorHandlerFunc) Optional

WithErrorHandler

func WithErrorMarshaler

func WithErrorMarshaler(ms runtime.Marshaler) Optional

WithErrorMarshaler

func WithLimiter

func WithLimiter(l *limit.Limiter) Optional

WithLimiter performs rate limiting on the request.

func WithMiddleWares

func WithMiddleWares(middleWares ...middleware.MuxMiddleware) Optional

WithMiddleWares pluggable function that performs middle wares.

func WithRunTimeOpts

func WithRunTimeOpts(opts runtime.ServeMuxOption) Optional

WithRunTimeOpts with runtime MuxOption

func WithTracer

func WithTracer(tracer opentracing.Tracer) Optional

WithTracer

func WithoutHTTPStatus

func WithoutHTTPStatus() Optional

WithoutHTTPStatus pluggable function that performs if use http status on response.