http_api

Documentation

Index

• func CompressHandler(h http.Handler) http.Handler
• func Decorate(f APIHandler, ds ...Decorator) httprouter.Handle
• func GetTopicChannelArgs(rp getter) (string, string, error)
• func LogMethodNotAllowedHandler(logf lg.AppLogFunc) http.Handler
• func LogNotFoundHandler(logf lg.AppLogFunc) http.Handler
• func LogPanicHandler(logf lg.AppLogFunc) func(w http.ResponseWriter, req *http.Request, p interface{})
• func NewDeadlineTransport(connectTimeout time.Duration, requestTimeout time.Duration) *http.Transport
• func RespondV1(w http.ResponseWriter, code int, data interface{})
• func Serve(listener net.Listener, handler http.Handler, proto string, logf lg.AppLogFunc) error
• type APIHandler
  • func DtJSON(f APIHandler) APIHandler
  • func PlainText(f APIHandler) APIHandler
  • func V1(f APIHandler) APIHandler
• type Client
  • func NewClient(tlsConfig *tls.Config, connectTimeout time.Duration, ...) *Client
  • func (c *Client) GETV1(endpoint string, v interface{}) error
  • func (c *Client) POSTV1(endpoint string) error
• type Decorator
  • func Log(logf lg.AppLogFunc) Decorator
• type Err
  • func (e Err) Error() string
• type ReqParams
  • func NewReqParams(req *http.Request) (*ReqParams, error)
  • func (r *ReqParams) Get(key string) (string, error)
  • func (r *ReqParams) GetAll(key string) ([]string, error)

Functions

func CompressHandler

func CompressHandler(h http.Handler) http.Handler

CompressHandler gzip compresses HTTP responses for clients that support it via the 'Accept-Encoding' header.

func Decorate

func Decorate(f APIHandler, ds ...Decorator) httprouter.Handle

func GetTopicChannelArgs

func GetTopicChannelArgs(rp getter) (string, string, error)

func LogMethodNotAllowedHandler

func LogMethodNotAllowedHandler(logf lg.AppLogFunc) http.Handler

func LogNotFoundHandler

func LogNotFoundHandler(logf lg.AppLogFunc) http.Handler

func LogPanicHandler

func LogPanicHandler(logf lg.AppLogFunc) func(w http.ResponseWriter, req *http.Request, p interface{})

func NewDeadlineTransport

func NewDeadlineTransport(connectTimeout time.Duration, requestTimeout time.Duration) *http.Transport

A custom http.Transport with support for deadline timeouts

func RespondV1

func RespondV1(w http.ResponseWriter, code int, data interface{})

func Serve

func Serve(listener net.Listener, handler http.Handler, proto string, logf lg.AppLogFunc) error

Types

type APIHandler

type APIHandler func(http.ResponseWriter, *http.Request, httprouter.Params) (interface{}, error)

func DtJSON

func DtJSON(f APIHandler) APIHandler

func PlainText

func PlainText(f APIHandler) APIHandler

func V1

func V1(f APIHandler) APIHandler

type Client

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

func NewClient

func NewClient(tlsConfig *tls.Config, connectTimeout time.Duration, requestTimeout time.Duration) *Client

func (*Client) GETV1

func (c *Client) GETV1(endpoint string, v interface{}) error

GETV1 is a helper function to perform a V1 HTTP request and parse our NSQ daemon's expected response format, with deadlines.

func (*Client) POSTV1

func (c *Client) POSTV1(endpoint string) error

PostV1 is a helper function to perform a V1 HTTP request and parse our NSQ daemon's expected response format, with deadlines.

type Decorator

type Decorator func(APIHandler) APIHandler

func Log

func Log(logf lg.AppLogFunc) Decorator

type Err

type Err struct {
	Code int
	Text string
}

func (Err) Error

func (e Err) Error() string

type ReqParams

type ReqParams struct {
	url.Values
	Body []byte
}

func NewReqParams

func NewReqParams(req *http.Request) (*ReqParams, error)

func (*ReqParams) Get

func (r *ReqParams) Get(key string) (string, error)

func (*ReqParams) GetAll

func (r *ReqParams) GetAll(key string) ([]string, error)