tinyhttp

Documentation

Overview

Package tinyhttp provides HTTP server implementation.

Index

• Variables
• type Server
  • func NewServer(address string, opts ...ServerOpt) *Server
  • func (s *Server) OnError(handler func(c *fiber.Ctx, err error) error)
  • func (s *Server) OnPanic(handler func(c *fiber.Ctx, recovered any))
  • func (s *Server) Start() error
  • func (s *Server) Stop()
• type ServerConfig
• type ServerOpt
  • func BodyLimit(bodyLimit int) ServerOpt
  • func Concurrency(concurrency int) ServerOpt
  • func FiberOption(opt func(*fiber.Config)) ServerOpt
  • func IdleTimeout(timeout time.Duration) ServerOpt
  • func Network(network string) ServerOpt
  • func ReadBufferSize(readBufferSize int) ServerOpt
  • func ReadTimeout(timeout time.Duration) ServerOpt
  • func RemoteIPHeader(header string) ServerOpt
  • func SecurityHeaders(securityHeaders bool) ServerOpt
  • func ShutdownTimeout(timeout time.Duration) ServerOpt
  • func TLS(cert, key string, tlsConfig ...*tls.Config) ServerOpt
  • func TrustedProxies(trustedProxies []string) ServerOpt
  • func ViewEngine(engine fiber.Views) ServerOpt
  • func ViewLayout(layout string) ServerOpt
  • func WriteBufferSize(writeBufferSize int) ServerOpt
  • func WriteTimeout(timeout time.Duration) ServerOpt
• type ValidationError
  • func BindBody(c *fiber.Ctx, out any) []ValidationError
  • func BindBodyForm(c *fiber.Ctx, out any) []ValidationError
  • func BindBodyJSON(c *fiber.Ctx, out any) []ValidationError
  • func ExtractValidatorErrors(err error) []ValidationError

Variables

var DefaultValidator = validator.New()

DefaultValidator is the default instance of validator.Validate.

Types

type Server

type Server struct {
	*fiber.App
	// contains filtered or unexported fields
}

Server is an object representing fiber.App and implementing the tiny.Service interface.

func NewServer

func NewServer(address string, opts ...ServerOpt) *Server

NewServer creates new Server instance.

func (*Server) OnError

func (s *Server) OnError(handler func(c *fiber.Ctx, err error) error)

OnError sets a handler for requests that resulted in error.

func (*Server) OnPanic

func (s *Server) OnPanic(handler func(c *fiber.Ctx, recovered any))

OnPanic sets a handler for requests that resulted in panic.

func (*Server) Start

func (s *Server) Start() error

Start implements the interface of tiny.Service.

func (*Server) Stop

func (s *Server) Stop()

Stop implements the interface of tiny.Service.

type ServerConfig

type ServerConfig struct {

	// Network is a network type for the listener (default: "tcp").
	Network string

	// SecurityHeaders defines whether to include HTTP security headers to all responses or not (default: true).
	SecurityHeaders bool

	// ShutdownTimeout defines a maximal timeout of HTTP server shutdown (default: 5s).
	ShutdownTimeout time.Duration

	// TLSCert is a path to TLS certificate to use. When specified with TLSKey - enables TLS mode.
	TLSCert string

	// TLSKey is a path to TLS key to use. When specified with TLSCert - enables TLS mode.
	TLSKey string

	// TLSConfig is an optional TLS configuration to pass when using TLS mode.
	TLSConfig *tls.Config

	// ReadTimeout is a timeout used when creating underlying http server (default: 5s).
	ReadTimeout time.Duration

	// WriteTimeout is a timeout used when creating underlying http server (default: 10s).
	WriteTimeout time.Duration

	// IdleTimeout is a timeout used when creating underlying http server (default 2m).
	IdleTimeout time.Duration

	// TrustedProxies is a list of CIDR address ranges that can be trusted when handling RemoteIP header.
	// (default: "10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16", "127.0.0.0/8", "fc00::/7", "::1/128")
	TrustedProxies []string

	// RemoteIPHeaders is a list of headers that overwrite the value of client's remote address.
	// (default: "X-Forwarded-For")
	RemoteIPHeader string

	// ViewEngine is a template rendering engine for fiber (default: nil).
	ViewEngine fiber.Views

	// ViewLayout is a global layout for ViewEngine (default: "").
	ViewLayout string

	// Concurrency specifies a maximum number of concurrent connections (default: 256 * 1024).
	Concurrency int

	// BodyLimit specifies a maximum allowed size for a request body (default: 4 * 1024 * 1024).
	BodyLimit int

	// ReadBufferSize specifies a per-connection buffer size (default: 4096).
	ReadBufferSize int

	// WriteBufferSize specifies a per-connection buffer size for responses (default: 4096).
	WriteBufferSize int
	// contains filtered or unexported fields
}

ServerConfig holds a configuration for NewServer.

type ServerOpt

type ServerOpt = func(*ServerConfig)

ServerOpt is an option to be specified to NewServer.

func BodyLimit

func BodyLimit(bodyLimit int) ServerOpt

BodyLimit specifies a maximum allowed size for a request body.

func Concurrency

func Concurrency(concurrency int) ServerOpt

Concurrency specifies a maximum number of concurrent connections.

func FiberOption

func FiberOption(opt func(*fiber.Config)) ServerOpt

FiberOption specifies user-defined function that directly modifies fiber config.

func IdleTimeout

func IdleTimeout(timeout time.Duration) ServerOpt

IdleTimeout is a timeout used when creating underlying http server.

func Network

func Network(network string) ServerOpt

Network is a network type for the listener.

func ReadBufferSize

func ReadBufferSize(readBufferSize int) ServerOpt

ReadBufferSize specifies a per-connection buffer size.

func ReadTimeout

func ReadTimeout(timeout time.Duration) ServerOpt

ReadTimeout is a timeout used when creating underlying http server.

func RemoteIPHeader

func RemoteIPHeader(header string) ServerOpt

RemoteIPHeader is a name of the header that overwrites the value of client's remote address.

func SecurityHeaders

func SecurityHeaders(securityHeaders bool) ServerOpt

SecurityHeaders defines whether to include HTTP security headers to all responses or not.

func ShutdownTimeout

func ShutdownTimeout(timeout time.Duration) ServerOpt

ShutdownTimeout defines a maximal timeout of HTTP server shutdown.

func TLS

func TLS(cert, key string, tlsConfig ...*tls.Config) ServerOpt

TLS enables TLS mode if both cert and key point to valid TLS credentials.

func TrustedProxies

func TrustedProxies(trustedProxies []string) ServerOpt

TrustedProxies is a list of CIDR address ranges that can be trusted when handling RemoteIP header.

func ViewEngine

func ViewEngine(engine fiber.Views) ServerOpt

ViewEngine is a template rendering engine for fiber.

func ViewLayout

func ViewLayout(layout string) ServerOpt

ViewLayout is a global layout for ViewEngine.

func WriteBufferSize

func WriteBufferSize(writeBufferSize int) ServerOpt

WriteBufferSize specifies a per-connection buffer size for responses.

func WriteTimeout

func WriteTimeout(timeout time.Duration) ServerOpt

WriteTimeout is a timeout used when creating underlying http server.

type ValidationError

type ValidationError struct {
	// Field is a name of the field that contains an error.
	Field string `json:"field"`

	// Tag is a name of the tag that trigger an error.
	Tag string `json:"tag"`

	// Err is an original error.
	Err validator.FieldError `json:"-"`
}

ValidationError denotes an error in payload validation.

func BindBody

func BindBody(c *fiber.Ctx, out any) []ValidationError

BindBody tries to parse provided request body and validate resulting object using the DefaultValidator.

func BindBodyForm

func BindBodyForm(c *fiber.Ctx, out any) []ValidationError

BindBodyForm tries to parse provided request Form body and validate resulting object using the DefaultValidator.

func BindBodyJSON

func BindBodyJSON(c *fiber.Ctx, out any) []ValidationError

BindBodyJSON tries to parse provided request JSON body and validate resulting object using the DefaultValidator.

func ExtractValidatorErrors

func ExtractValidatorErrors(err error) []ValidationError

ExtractValidatorErrors tries to extract an array of ValidationError from given error.