rapi

README

rapi

Documentation

Index

• type Caller
  • func (c *Caller) Call(ctx context.Context, in interface{}, opts ...CallerOption) (result *Response, err error)
• type CallerError
• type CallerOption
  • func WithAdditionalRequestHeader(header ...http.Header) CallerOption
  • func WithErrOut(errOut error) CallerOption
  • func WithForceBody(forceBody bool) CallerOption
  • func WithMaxResponseBodySize(maxResponseBodySize int64) CallerOption
  • func WithRequestHeader(header ...http.Header) CallerOption
• type DoFunc
• type Factory
  • func NewFactory(client *http.Client, u *url.URL, opts ...CallerOption) (f *Factory)
  • func (f *Factory) Caller(endpoint string, method string, out interface{}, opts ...CallerOption) *Caller
• type Handler
  • func NewHandler(opts ...HandlerOption) (h *Handler)
  • func (h *Handler) Handle(pattern string, opts ...HandlerOption) *PatternHandler
  • func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type HandlerOption
  • func WithAllowEncoding(allowEncoding bool) HandlerOption
  • func WithMaxRequestBodySize(maxRequestBodySize int64) HandlerOption
  • func WithMiddleware(middleware ...MiddlewareFunc) HandlerOption
  • func WithOnError(onError func(error, *http.Request)) HandlerOption
  • func WithRequestTimeout(requestTimeout time.Duration) HandlerOption
  • func WithResponseTimeout(responseTimeout time.Duration) HandlerOption
• type HeaderOption
  • func ParseHeaderOptions(directive string) (options []HeaderOption)
• type HeaderOptionKeyVal
• type MiddlewareFunc
• type PatternHandler
  • func (h *PatternHandler) Register(method string, in interface{}, do DoFunc, opts ...HandlerOption) *PatternHandler
  • func (h *PatternHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Request
• type Response
• type SendFunc

Types

type Caller

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

func (*Caller) Call

func (c *Caller) Call(ctx context.Context, in interface{}, opts ...CallerOption) (result *Response, err error)

type CallerError

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

type CallerOption

type CallerOption interface {
	// contains filtered or unexported methods
}

func WithAdditionalRequestHeader

func WithAdditionalRequestHeader(header ...http.Header) CallerOption

func WithErrOut

func WithErrOut(errOut error) CallerOption

func WithForceBody

func WithForceBody(forceBody bool) CallerOption

func WithMaxResponseBodySize

func WithMaxResponseBodySize(maxResponseBodySize int64) CallerOption

func WithRequestHeader

func WithRequestHeader(header ...http.Header) CallerOption

type DoFunc

type DoFunc func(req *Request, send SendFunc)

type Factory

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

func NewFactory

func NewFactory(client *http.Client, u *url.URL, opts ...CallerOption) (f *Factory)

func (*Factory) Caller

func (f *Factory) Caller(endpoint string, method string, out interface{}, opts ...CallerOption) *Caller

type Handler

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

func NewHandler

func NewHandler(opts ...HandlerOption) (h *Handler)

func (*Handler) Handle

func (h *Handler) Handle(pattern string, opts ...HandlerOption) *PatternHandler

func (*Handler) ServeHTTP

func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type HandlerOption

type HandlerOption interface {
	// contains filtered or unexported methods
}

func WithAllowEncoding

func WithAllowEncoding(allowEncoding bool) HandlerOption

func WithMaxRequestBodySize

func WithMaxRequestBodySize(maxRequestBodySize int64) HandlerOption

func WithMiddleware

func WithMiddleware(middleware ...MiddlewareFunc) HandlerOption

func WithOnError

func WithOnError(onError func(error, *http.Request)) HandlerOption

func WithRequestTimeout

func WithRequestTimeout(requestTimeout time.Duration) HandlerOption

func WithResponseTimeout

func WithResponseTimeout(responseTimeout time.Duration) HandlerOption

type HeaderOption

type HeaderOption struct {
	KeyVals []HeaderOptionKeyVal
	Map     map[string]string
}

func ParseHeaderOptions

func ParseHeaderOptions(directive string) (options []HeaderOption)

type HeaderOptionKeyVal

type HeaderOptionKeyVal struct {
	Key string
	Val string
}

type MiddlewareFunc

type MiddlewareFunc func(req *Request, send SendFunc, do DoFunc)

type PatternHandler

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

func (*PatternHandler) Register

func (h *PatternHandler) Register(method string, in interface{}, do DoFunc, opts ...HandlerOption) *PatternHandler

func (*PatternHandler) ServeHTTP

func (h *PatternHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type Request

type Request struct {
	*http.Request
	In interface{}
}

type Response

type Response struct {
	*http.Response
	Data []byte
	Out  interface{}
}

type SendFunc

type SendFunc func(out interface{}, code int, header ...http.Header)