uhttp

Oct 10, 2023

Changes in this version

type ContextKey

+ const CtxKeyUHTTP

type UHTTP

+ func GetUHTTP(r *http.Request) *UHTTP

Oct 4, 2023

Changes in this version

type HandlerOption

+ func WithDebugRawRequestBody(fn func([]byte)) HandlerOption

Oct 4, 2023

Changes in this version

type UhttpOption

+ func WithLogEncodingError(fn func(template string, args ...interface{})) UhttpOption

+ func WithLogHandlerError(fn func(template string, args ...interface{})) UhttpOption

+ func WithLogParseModelError(fn func(template string, args ...interface{})) UhttpOption

Jul 3, 2023

Changes in this version

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

+ func StaticFilesHandler(u *UHTTP) http.HandlerFunc

type UHTTP

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

Jul 3, 2023

Changes in this version

type Logger

+ func NewDefaultLogger() Logger

+ func NewDiscardLogger() Logger

+ Errorf func(template string, args ...interface{})

+ Infof func(template string, args ...interface{})

Jun 7, 2022

Changes in this version

type UhttpOption

+ func WithHandlerErrorLogLevel(logErrors bool, level ulog.LogLevel) UhttpOption

Apr 6, 2022

Changes in this version

type HandlerOption

+ func WithDisableAccessLogging() HandlerOption

Apr 4, 2022

Changes in this version

type HandlerOption

+ func WithCacheFailedRequests() HandlerOption

Jan 28, 2022

Changes in this version

type UHTTP

+ func (u *UHTTP) MetricsServeMux() (*http.ServeMux, error)

Jan 27, 2022

Changes in this version

type Middleware

+ func AuthBasic(u *UHTTP, expectedUsername string, expectedHashedPasswordSha256 string) Middleware

type UHTTP

+ func (u *UHTTP) ExposeCacheHandlers(middlewares ...Middleware)

Nov 22, 2021

Changes in this version

type UhttpOption

+ func WithHandleHandlerPanics(fn func(r *http.Request, err error)) UhttpOption

Oct 26, 2021

Changes in this version

+ const DURATION

+ func GetAsDuration(key string, r *http.Request) *time.Duration

+ func GetAsDurationFromContext(key string, ctx context.Context) *time.Duration

Oct 20, 2021

Changes in this version

+ const ENCODING_BROTLI

+ const ENCODING_DEFLATE

+ const ENCODING_GZIP

+ const ENCODING_PLAIN

+ const HEADER_ACCEPT_ENCODING

+ const HEADER_CONTENT_ENCODING

type ContextKey

+ const CtxKeyTest

type HandlerOption

+ func WithCachePersistEncodings() HandlerOption

Oct 19, 2021

Changes in this version

+ func DecodingReader(header http.Header, body io.ReadCloser) (io.ReadCloser, error)

+ func IsAutomaticCacheExecution(r *http.Request) bool

+ func RequireHTTPHeader(t *testing.T, handler http.HandlerFunc, method string, url string, ...)

type ContextKey

+ const CtxKeyIsAutomaticCacheExecution

type UhttpOption

+ func WithLogCacheRuns(logCacheRuns bool) UhttpOption

Oct 14, 2021

Changes in this version

type UhttpOption

+ func WithBrotliCompression(enable bool, level int) UhttpOption

+ func WithCachePersistDifferentEncodings(persist bool) UhttpOption

+ func WithDeflateCompression(enable bool, level int) UhttpOption

+ func WithGzipCompression(enable bool, level int) UhttpOption

Oct 14, 2021

Changes in this version

+ func ExtractAndRestoreRequestBody(r *http.Request) []byte

Oct 14, 2021

Changes in this version

type UhttpOption

+ func WithLogCustomMiddlewareRegistration() UhttpOption

Oct 14, 2021

Changes in this version

+ const CACHE_HEADER

+ const CACHE_HEADER_AGE_HUMAN_READABLE

+ const CACHE_HEADER_AGE_MS

+ const NO_LOG_MAGIC_URL_FORCE_CACHE

+ func RequireHTTPBodyAndHeader(t *testing.T, handler http.HandlerFunc, method string, url string, ...)

+ func RequireHTTPBodyAndNotHeader(t *testing.T, handler http.HandlerFunc, method string, url string, ...)

+ func RequireHTTPBodyJSONEq(t *testing.T, handlerFunc http.HandlerFunc, method string, url string, ...)

type ContextKey

+ const CtxKeyCache

type HandlerOption

+ func WithAutomaticCacheUpdates(interval time.Duration) HandlerOption

+ func WithCache(maxAge time.Duration) HandlerOption

type UhttpOption

+ func WithCacheTTLEnforcerInterval(i time.Duration) UhttpOption

+ func WithExposeCacheHandlers(exposeCacheHandlers bool) UhttpOption

Sep 23, 2021

Changes in this version

type UhttpOption

+ func WithSilentStaticFileRegistration(makeFileRegistrationSilent bool) UhttpOption

Jul 26, 2021

Changes in this version

type UhttpOption

+ func WithGranularLogging(logHandlerCalls bool, logHandlerErrors bool, logHandlerRegistrations bool) UhttpOption

Mar 22, 2021

Changes in this version

type UhttpOption

+ func WithStaticFileEncodings(enableGzip bool, enableBrotli bool) UhttpOption

Mar 13, 2021

Changes in this version

type UHTTP

+ func (u *UHTTP) CORS() string

+ func (u *UHTTP) Log() ulog.ULogger

Jan 11, 2021

Changes in this version

+ func ErrorFromHttpResponseBody(r io.ReadCloser) (error, error)

+ type HttpResponseErrorModel struct

+ Error string

+ func NewHttpErrorResponse(err error) HttpResponseErrorModel

Nov 23, 2020

Changes in this version

type UhttpOption

+ func WithSendPanicInfoToClient(sendPanicInfoToClient bool) UhttpOption

Oct 28, 2020

Changes in this version

type LoggingResponseWriter

+ func (lrw *LoggingResponseWriter) Header() http.Header

+ func (lrw *LoggingResponseWriter) Hijack() (net.Conn, *bufio.ReadWriter, error)

+ func (lrw *LoggingResponseWriter) Write(data []byte) (int, error)

Jul 24, 2020

Changes in this version

type ContextKey

+ const CtxKeyResponseWriter

Jun 14, 2020

Changes in this version

+ const Metric_Requests_Duration

+ const Metric_Requests_Total

+ func HandleMetrics(metrics map[string]interface{}, method string, status int, uri string, ...) error

type UhttpOption

+ func WithMetrics(metricsSocket string, metricsPath string, metricsName string) UhttpOption

Jun 14, 2020

Changes in this version

type ContextKey

+ func ContextKeysFromMap(m interface{}) []ContextKey

Jun 14, 2020

Changes in this version

+ type ContextKey string

May 27, 2020

Changes in this version

type UHTTP

+ func (u *UHTTP) ServeMux() *http.ServeMux

May 27, 2020

Changes in this version

type UhttpOption

+ func WithTLS(certPath string, keyPath string, tlsErrorLogger *log.Logger) UhttpOption

May 7, 2020

Changes in this version

type HandlerOption

+ func WithOptionalGet(r R) HandlerOption

May 5, 2020

Changes in this version

+ func NewHandler(opts ...HandlerOption) *handlerOptions

+ type HandlerFunc func(r *http.Request, returnCode *int) interface

+ type HandlerFuncWithModel func(r *http.Request, model interface{}, returnCode *int) interface

+ type HandlerOption interface

+ func WithDelete(h HandlerFunc) HandlerOption

+ func WithDeleteModel(m interface{}, h HandlerFuncWithModel) HandlerOption

+ func WithGet(h HandlerFunc) HandlerOption

+ func WithGetModel(m interface{}, h HandlerFuncWithModel) HandlerOption

+ func WithMiddlewares(m []Middleware) HandlerOption

+ func WithOptionsGet(r R) HandlerOption

+ func WithPost(h HandlerFunc) HandlerOption

+ func WithPostModel(m interface{}, h HandlerFuncWithModel) HandlerOption

+ func WithPreProcess(p PreProcessFunc) HandlerOption

+ func WithRequiredGet(r R) HandlerOption

+ func WithTimeout(timeout time.Duration, timeoutMessage string) HandlerOption

+ type PreProcessFunc func(ctx context.Context) error

+ type UHTTP struct

+ func NewUHTTP(opts ...UhttpOption) *UHTTP

+ func (u *UHTTP) AddContext(key string, value interface{}) error

+ func (u *UHTTP) Handle(pattern string, opts ...HandlerOption)

+ func (u *UHTTP) ListenAndServe() error

+ func (u *UHTTP) RegisterStaticFilesHandler(root string) error

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

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

+ func (u *UHTTP) RenderErrorWithStatusCode(w http.ResponseWriter, r *http.Request, statusCode int, err error, logOut bool)

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

+ type UhttpOption interface

+ func WithAddress(address string) UhttpOption

+ func WithCORS(cors string) UhttpOption

+ func WithEncodingErrorLogLevel(level ulog.LogLevel) UhttpOption

+ func WithGlobalMiddlewares(middlewares []Middleware) UhttpOption

+ func WithGzipCompressionLevel(level int) UhttpOption

+ func WithIdleTimeout(idleTimeout time.Duration) UhttpOption

+ func WithLogger(logger ulog.ULogger) UhttpOption

+ func WithParseModelErrorLogLevel(level ulog.LogLevel) UhttpOption

+ func WithReadHeaderTimeout(readHeaderTimeout time.Duration) UhttpOption

+ func WithReadTimeout(readTimeout time.Duration) UhttpOption

+ func WithWriteTimeout(writeTimeout time.Duration) UhttpOption

May 1, 2020

Changes in this version

+ func RegisterStaticFilesHandler(root string) error

+ func ServeMux() *http.ServeMux

type Config

+ Mux *http.ServeMux

Mar 26, 2020

Changes in this version

type Config

+ ParseModelErrorLogLevel *ulog.LogLevel

Mar 17, 2020

Changes in this version

type Config

+ EncodingErrorLogLevel *ulog.LogLevel

Feb 18, 2020

Changes in this version

type Handler

+ Timeout *time.Duration

+ TimeoutMessage *string

Jan 4, 2020

Changes in this version

+ func ExecuteHandlerWithGzipRequestAndResponse(handler Handler, method string, expectedStatus int, requestBody []byte, ...)

+ func ExecuteHandlerWithGzipResponse(handler Handler, method string, expectedStatus int, requestBody []byte, ...)

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

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

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

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

Jan 4, 2020

Changes in this version

+ const BOOL

+ const CtxKeyAddLogging

+ const CtxKeyGetParams

+ const CtxKeyPostModel

+ const FLOAT32

+ const FLOAT64

+ const INT

+ const INT32

+ const INT64

+ const RFC3339_DATE

+ const SHORT_DATE

+ const STRING

+ var Logger ulog.ULogger = ulog.NewUlog()

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

+ func AddLoggingMiddleware(next http.HandlerFunc) http.HandlerFunc

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

+ func ExecuteHandler(handler Handler, method string, 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 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 PreProcessMiddleware(preProcess func(ctx context.Context) error) func(next http.HandlerFunc) http.HandlerFunc

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

+ func SetJSONResponseMiddleware(next http.HandlerFunc) http.HandlerFunc

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

+ func WithContextMiddleware(key string, value interface{}) func(next http.HandlerFunc) http.HandlerFunc

+ type LoggingResponseWriter struct

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

+ func (lrw *LoggingResponseWriter) WriteHeader(code int)

+ type R map[string]interface

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

Dec 19, 2019

Changes in this version

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

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

type Config

+ GzipCompressionLevel *int

Oct 4, 2019

Changes in this version

+ func RealIP(r *http.Request) string

Oct 3, 2019

Changes in this version

type Config

+ CORS *string

type Handler

+ func (h Handler) WsReady() Middleware

Sep 24, 2019

Changes in this version

+ func AddContext(key string, value interface{})

+ func AddContexts(m ContextMap)

+ func AddMiddleware(mw Middleware)

+ func Handle(pattern string, handler Handler)

+ func ParsedModel(r *http.Request) interface

+ 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)

+ type Config struct

+ CustomLog ulog.ULogger

+ DisableCORS *bool

+ func GetConfig() Config

+ type ContextMap map[string]interface

+ func RequestContext() ContextMap

+ type Handler struct

+ AddMiddleware *Middleware

+ AddMiddlewares []Middleware

+ DeleteHandler http.HandlerFunc

+ DeleteModel interface{}

+ GetHandler http.HandlerFunc

+ GetModel interface{}

+ OptionalGet params.R

+ Pattern string

+ PostHandler http.HandlerFunc

+ PostModel interface{}

+ PreProcess func(ctx context.Context) error

+ RequiredGet params.R

+ func (h Handler) HandlerFunc() http.HandlerFunc

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

+ func AdditionalMiddlewares() []Middleware

+ func Chain(mw ...Middleware) Middleware