rapi

README

rapi

Documentation

Index

• type CallOption
  • func WithAdditionalRequestHeader(header ...http.Header) CallOption
  • func WithErrOut(errOut error) CallOption
  • func WithForceBody(forceBody bool) CallOption
  • func WithMaxResponseBodySize(maxResponseBodySize int64) CallOption
  • func WithRequestHeader(header ...http.Header) CallOption
• type Caller
  • func (c *Caller) Call(ctx context.Context, in interface{}, opts ...CallOption) (result *Response, err error)
• type DoFunc
• type Factory
  • func NewFactory(client *http.Client, u *url.URL, opts ...CallOption) (f *Factory)
  • func (f *Factory) Caller(endpoint string, method string, out interface{}, opts ...CallOption) *Caller
• type Handler
  • func NewHandler(opts ...HandlerOption) (h *Handler)
  • func (h *Handler) Handle(pattern string, opts ...HandlerOption) Registrar
  • 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 InvalidContentTypeError
  • func (e *InvalidContentTypeError) ContentType() string
  • func (e *InvalidContentTypeError) Error() string
• type MiddlewareFunc
• type Registrar
• type Request
• type RequestError
  • func (e *RequestError) Error() string
• type Response
• type SendFunc

Types

type CallOption

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

func WithAdditionalRequestHeader

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

func WithErrOut

func WithErrOut(errOut error) CallOption

func WithForceBody

func WithForceBody(forceBody bool) CallOption

func WithMaxResponseBodySize

func WithMaxResponseBodySize(maxResponseBodySize int64) CallOption

func WithRequestHeader

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

type Caller

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

Caller is the HTTP requester to do JSON requests with the given method to the given endpoint. The method and endpoint are given from Factory.

func (*Caller) Call

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

Call does the HTTP request with the given input and CallOption's.

type DoFunc

type DoFunc func(req *Request, send SendFunc)

type Factory

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

Factory is Caller factory to create new Caller's.

func NewFactory

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

NewFactory creates a new Factory.

func (*Factory) Caller

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

Caller creates a new Caller with the given endpoint and method.

type Handler

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

Handler implements http.Handler to process JSON requests based on pattern and registered methods. Handler is similar to http.ServeMux in terms of operation.

func NewHandler

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

NewHandler creates a new Handler by given HandlerOption's.

func (*Handler) Handle

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

Handle creates a Registrar to register methods for the given pattern.

func (*Handler) ServeHTTP

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

ServeHTTP is implementation of http.Handler.

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 InvalidContentTypeError

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

func (*InvalidContentTypeError) ContentType

func (e *InvalidContentTypeError) ContentType() string

func (*InvalidContentTypeError) Error

func (e *InvalidContentTypeError) Error() string

type MiddlewareFunc

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

type Registrar

type Registrar interface {
	Register(method string, in interface{}, do DoFunc, opts ...HandlerOption) Registrar
}

Registrar is method registrar and created by Handler.

type Request

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

type RequestError

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

func (*RequestError) Error

func (e *RequestError) Error() string

type Response

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

type SendFunc

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