server

Documentation

Index

• Variables
• func GetLimitAndOffsetParams(values url.Values) (offset uint64, limit uint64, err error)
• func NewBaseRouter(h BaseHTTPHandler, cfg BaseRouterCfg) (*mux.Router, error)
• type BaseHTTPHandler
  • func (BaseHTTPHandler) GetLimitAndOffset(values url.Values) (offset uint64, limit uint64, err error)
  • func (h BaseHTTPHandler) NewLoggingResponseWriter(w http.ResponseWriter, r *http.Request) LoggingResponseWriter
• type BaseRouterCfg
• type LoggingResponseWriter

Variables

var (
	// ErrHandlerConfigIsNotFull will be returned if some handlers Config fields are not populated
	ErrHandlerConfigIsNotFull = errors.New("some handlers Config fields are not populated")
	// ErrServerConfigIsNotFull will be returned if some servers Config fields are not populated
	ErrServerConfigIsNotFull = errors.New("some servers Config fields are not populated")
)

Functions

func GetLimitAndOffsetParams

func GetLimitAndOffsetParams(values url.Values) (offset uint64, limit uint64, err error)

GetLimitAndOffsetParams parses offset anf limit from url values

func NewBaseRouter

func NewBaseRouter(h BaseHTTPHandler, cfg BaseRouterCfg) (*mux.Router, error)

NewBaseRouter will return new router with already registered standard endpoints /version.json - to serve service version {cfg.ApiDefinition} - to serve api schema {ProfilerPath} - to serve http profiler

Types

type BaseHTTPHandler

type BaseHTTPHandler struct {
	Logger logrus.FieldLogger
}

BaseHTTPHandler stores common dependencies and methods for any http api in system.

func (BaseHTTPHandler) GetLimitAndOffset

func (BaseHTTPHandler) GetLimitAndOffset(values url.Values) (offset uint64, limit uint64, err error)

GetLimitAndOffset will return parsed limit and offset from url.Values.

func (BaseHTTPHandler) NewLoggingResponseWriter

func (h BaseHTTPHandler) NewLoggingResponseWriter(w http.ResponseWriter, r *http.Request) LoggingResponseWriter

NewLoggingResponseWriter creates new loggingResponseWriter instance for particular request

type BaseRouterCfg

type BaseRouterCfg struct {
	ServiceVersion string

	ProfilerPath string

	APIDefinition     io.Reader
	APIDefinitionPath string
}

BaseRouterCfg stores configs for base router

type LoggingResponseWriter

type LoggingResponseWriter interface {
	// WriteHeader will set and log response status code
	WriteHeader(code int)
	// WriteHeaderWithErr same as WriteHeader but also will set and log error with metadata
	WriteHeaderWithErr(code int, err error)
	// WriteJSON is a helper that will set corresponding content type, encode your data and log response
	WriteJSON(data interface{})
	// WriteXML is a helper that will set corresponding content type, encode your data and log response
	WriteXML(data interface{})
}

LoggingResponseWriter describes methods of loggingResponseWriter helper