uhttp

README

uhttp

A simple http-framework. Working but not yet well documented...

Documentation

Index

• Constants
• Variables
• func AddContext(key string, value interface{})
• func AddLogOutput(w interface{}, key, value string) error
• func AddLoggingMiddleware(next http.HandlerFunc) http.HandlerFunc
• func AddMiddleware(mw Middleware) error
• func ENUM(values ...string) []string
• func ExecuteHandler(handler Handler, method string, expectedStatus int, requestBody []byte, ...)
• func ExecuteHandlerWithGzipRequestAndResponse(handler Handler, method string, expectedStatus int, requestBody []byte, ...)
• func ExecuteHandlerWithGzipResponse(handler Handler, method string, expectedStatus int, requestBody []byte, ...)
• func GetAsBool(key string, r *http.Request) *bool
• func GetAsBoolFromContext(key string, ctx context.Context) *bool
• func GetAsFloat32(key string, r *http.Request) *float32
• func GetAsFloat32FromContext(key string, ctx context.Context) *float32
• func GetAsFloat64(key string, r *http.Request) *float64
• func GetAsFloat64FromContext(key string, ctx context.Context) *float64
• func GetAsInt(key string, r *http.Request) *int
• func GetAsInt32(key string, r *http.Request) *int32
• func GetAsInt32FromContext(key string, ctx context.Context) *int32
• func GetAsInt64(key string, r *http.Request) *int64
• func GetAsInt64FromContext(key string, ctx context.Context) *int64
• func GetAsIntFromContext(key string, ctx context.Context) *int
• func GetAsString(key string, r *http.Request) *string
• func GetAsStringFromContext(key string, ctx context.Context) *string
• func GetAsTime(key string, r *http.Request) *time.Time
• func GetAsTimeFromContext(key string, ctx context.Context) *time.Time
• func GetParamsMiddleware(optionalGet R, requiredGet R) func(next http.HandlerFunc) http.HandlerFunc
• func GzipDecodeRequestBody(r *http.Request, model interface{}) error
• func GzipDecodeResponseBody(res *http.Response) ([]byte, error)
• func GzipEncodeRequestBody(body []byte) (io.ReadCloser, error)
• func Handle(pattern string, handler Handler)
• func ParseBool(value string, key string, validatedMap R, errors *[]error)
• func ParseDate(value string, key string, format string, validatedMap R, errors *[]error)
• func ParseEnum(value string, enum []string, key string, validatedMap R, errors *[]error)
• func ParseFloat(value string, key string, bits int, validatedMap R, errors *[]error)
• func ParseInt(value string, key string, bits int, validatedMap R, errors *[]error)
• func ParseModelMiddleware(postModel interface{}, getModel interface{}, deleteModel interface{}) func(next http.HandlerFunc) http.HandlerFunc
• func ParseString(value string, key string, validatedMap R, errors *[]error)
• func ParsedModel(r *http.Request) interface{}
• func PreProcessMiddleware(preProcess func(ctx context.Context) error) func(next http.HandlerFunc) http.HandlerFunc
• func ReaderHelper(header http.Header, body io.ReadCloser) (io.Reader, error)
• func Render(w http.ResponseWriter, r *http.Request, model interface{})
• func RenderError(w http.ResponseWriter, r *http.Request, err error)
• func RenderErrorWithStatusCode(w http.ResponseWriter, r *http.Request, statusCode int, err error)
• func RenderMessage(w http.ResponseWriter, r *http.Request, msg string)
• func RenderMessageWithStatusCode(w http.ResponseWriter, r *http.Request, statusCode int, msg string)
• func RenderWithStatusCode(w http.ResponseWriter, r *http.Request, statusCode int, model interface{})
• func SelectMethod(chain Middleware, handler Handler) http.HandlerFunc
• func ServeSinglePageApp(path string, mainHTMLFile string)
• func SetConfig(_config Config)
• func SetCorsMiddleware(CORSString *string) func(next http.HandlerFunc) http.HandlerFunc
• func SetJSONResponseMiddleware(next http.HandlerFunc) http.HandlerFunc
• func SinglePageAppHandler(path string, mainHTMLFile string) http.HandlerFunc
• func ValidateParams(requirement R, actual map[string]string, destination R, required bool) error
• type Config
  • func GetConfig() Config
• type ContextMap
  • func RequestContext() ContextMap
• type Handler
  • func (h Handler) HandlerFunc() http.HandlerFunc
  • func (h Handler) WsReady() Middleware
• type LoggingResponseWriter
  • func (lrw *LoggingResponseWriter) AddLogOutput(key, value string)
  • func (lrw *LoggingResponseWriter) WriteHeader(code int)
• type Middleware
  • func AdditionalMiddlewares() []Middleware
  • func Chain(mw ...Middleware) Middleware
  • func WithContextMiddleware(key string, value interface{}) Middleware
• type R
  • func (r R) Printable() (map[string]string, error)

Constants

const (
	CtxKeyPostModel string = "uhttp.postModel"
	CtxKeyGetParams string = "uhttp.getParams"
)

const (
	STRING       string = "string"
	BOOL         string = "bool"
	INT          string = "int"
	INT32        string = "int32"
	INT64        string = "int64"
	FLOAT32      string = "float32"
	FLOAT64      string = "float64"
	SHORT_DATE   string = "shortDate" // 2006-01-02
	RFC3339_DATE string = "rfc3339Date"
)

Variables

var Logger ulog.ULogger = ulog.NewUlog()

Functions

func AddContext

func AddContext(key string, value interface{})

func AddLogOutput

func AddLogOutput(w interface{}, key, value string) error

func AddLoggingMiddleware

func AddLoggingMiddleware(next http.HandlerFunc) http.HandlerFunc

Logging log time, method and path of an HTTP-Request

func AddMiddleware

func AddMiddleware(mw Middleware) error

func ENUM

func ENUM(values ...string) []string

func ExecuteHandler

func ExecuteHandler(
	handler Handler,
	method string,
	expectedStatus int,
	requestBody []byte,
	expectedResponseBody []byte,
	t *testing.T,
)

func ExecuteHandlerWithGzipRequestAndResponse

func ExecuteHandlerWithGzipRequestAndResponse(
	handler Handler,
	method string,
	expectedStatus int,
	requestBody []byte,
	expectedResponseBody []byte,
	t *testing.T,
)

func ExecuteHandlerWithGzipResponse

func ExecuteHandlerWithGzipResponse(
	handler Handler,
	method string,
	expectedStatus int,
	requestBody []byte,
	expectedResponseBody []byte,
	t *testing.T,
)

func GetAsBool

func GetAsBool(key string, r *http.Request) *bool

func GetAsBoolFromContext

func GetAsBoolFromContext(key string, ctx context.Context) *bool

func GetAsFloat32

func GetAsFloat32(key string, r *http.Request) *float32

func GetAsFloat32FromContext

func GetAsFloat32FromContext(key string, ctx context.Context) *float32

func GetAsFloat64

func GetAsFloat64(key string, r *http.Request) *float64

func GetAsFloat64FromContext

func GetAsFloat64FromContext(key string, ctx context.Context) *float64

func GetAsInt

func GetAsInt(key string, r *http.Request) *int

func GetAsInt32

func GetAsInt32(key string, r *http.Request) *int32

func GetAsInt32FromContext

func GetAsInt32FromContext(key string, ctx context.Context) *int32

func GetAsInt64

func GetAsInt64(key string, r *http.Request) *int64

func GetAsInt64FromContext

func GetAsInt64FromContext(key string, ctx context.Context) *int64

func GetAsIntFromContext

func GetAsIntFromContext(key string, ctx context.Context) *int

func GetAsString

func GetAsString(key string, r *http.Request) *string

func GetAsStringFromContext

func GetAsStringFromContext(key string, ctx context.Context) *string

func GetAsTime

func GetAsTime(key string, r *http.Request) *time.Time

func GetAsTimeFromContext

func GetAsTimeFromContext(key string, ctx context.Context) *time.Time

func GetParamsMiddleware

func GetParamsMiddleware(optionalGet R, requiredGet R) func(next http.HandlerFunc) http.HandlerFunc

func GzipDecodeRequestBody

func GzipDecodeRequestBody(r *http.Request, model interface{}) error

func GzipDecodeResponseBody

func GzipDecodeResponseBody(res *http.Response) ([]byte, error)

func GzipEncodeRequestBody

func GzipEncodeRequestBody(body []byte) (io.ReadCloser, error)

func Handle

func Handle(pattern string, handler Handler)

Handle configuration

func ParseBool

func ParseBool(value string, key string, validatedMap R, errors *[]error)

func ParseDate

func ParseDate(value string, key string, format string, validatedMap R, errors *[]error)

func ParseEnum

func ParseEnum(value string, enum []string, key string, validatedMap R, errors *[]error)

func ParseFloat

func ParseFloat(value string, key string, bits int, validatedMap R, errors *[]error)

func ParseInt

func ParseInt(value string, key string, bits int, validatedMap R, errors *[]error)

func ParseModelMiddleware

func ParseModelMiddleware(postModel interface{}, getModel interface{}, deleteModel interface{}) func(next http.HandlerFunc) http.HandlerFunc

ParseModel parses and adds a model from a requestbody if wanted

func ParseString

func ParseString(value string, key string, validatedMap R, errors *[]error)

func ParsedModel

func ParsedModel(r *http.Request) interface{}

func PreProcessMiddleware

func PreProcessMiddleware(preProcess func(ctx context.Context) error) func(next http.HandlerFunc) http.HandlerFunc

func ReaderHelper

func ReaderHelper(header http.Header, body io.ReadCloser) (io.Reader, error)

inspired by https://medium.com/axiomzenteam/put-your-http-requests-on-a-diet-3e1e52333014

func Render

func Render(w http.ResponseWriter, r *http.Request, model interface{})

func RenderError

func RenderError(w http.ResponseWriter, r *http.Request, err error)

func RenderErrorWithStatusCode

func RenderErrorWithStatusCode(w http.ResponseWriter, r *http.Request, statusCode int, err error)

func RenderMessage

func RenderMessage(w http.ResponseWriter, r *http.Request, msg string)

func RenderMessageWithStatusCode

func RenderMessageWithStatusCode(w http.ResponseWriter, r *http.Request, statusCode int, msg string)

func RenderWithStatusCode

func RenderWithStatusCode(w http.ResponseWriter, r *http.Request, statusCode int, model interface{})

func SelectMethod

func SelectMethod(chain Middleware, handler Handler) http.HandlerFunc

func ServeSinglePageApp

func ServeSinglePageApp(path string, mainHTMLFile string)

ServeSinglePageApp

func SetConfig

func SetConfig(_config Config)

SetConfig set config for all handlers

func SetCorsMiddleware

func SetCorsMiddleware(CORSString *string) func(next http.HandlerFunc) http.HandlerFunc

SetCors set response headers

func SetJSONResponseMiddleware

func SetJSONResponseMiddleware(next http.HandlerFunc) http.HandlerFunc

SetJSONResponse set response headers

func SinglePageAppHandler

func SinglePageAppHandler(path string, mainHTMLFile string) http.HandlerFunc

Exposed handler for testing

func ValidateParams

func ValidateParams(requirement R, actual map[string]string, destination R, required bool) error

Types

type Config

type Config struct {
	CORS                  *string
	CustomLog             ulog.ULogger
	GzipCompressionLevel  *int
	EncodingErrorLogLevel *ulog.LogLevel
}

func GetConfig

func GetConfig() Config

type ContextMap

type ContextMap map[string]interface{}

func RequestContext

func RequestContext() ContextMap

type Handler

type Handler struct {
	Pattern        string
	PostHandler    http.HandlerFunc
	PostModel      interface{}
	GetHandler     http.HandlerFunc
	GetModel       interface{}
	DeleteHandler  http.HandlerFunc
	DeleteModel    interface{}
	RequiredGet    R
	OptionalGet    R
	AddMiddlewares []Middleware
	AddMiddleware  *Middleware
	PreProcess     func(ctx context.Context) error
	Timeout        *time.Duration
	TimeoutMessage *string
}

Handler configured

func (Handler) HandlerFunc

func (h Handler) HandlerFunc() http.HandlerFunc

func (Handler) WsReady

func (h Handler) WsReady() Middleware

type LoggingResponseWriter

type LoggingResponseWriter struct {
	http.ResponseWriter
	// contains filtered or unexported fields
}

func (*LoggingResponseWriter) AddLogOutput

func (lrw *LoggingResponseWriter) AddLogOutput(key, value string)

func (*LoggingResponseWriter) WriteHeader

func (lrw *LoggingResponseWriter) WriteHeader(code int)

type Middleware

type Middleware func(next http.HandlerFunc) http.HandlerFunc

func AdditionalMiddlewares

func AdditionalMiddlewares() []Middleware

func Chain

func Chain(mw ...Middleware) Middleware

Chain chain multiple middlewares copied from: https://hackernoon.com/simple-http-middleware-with-go-79a4ad62889b

func WithContextMiddleware

func WithContextMiddleware(key string, value interface{}) Middleware

WithContext attaches any object to the context

type R

type R map[string]interface{}

func (R) Printable

func (r R) Printable() (map[string]string, error)