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 IdleTimeout(timeout time.Duration) ServerOpt
  • func Network(network string) 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) ServerOpt
  • func TrustedProxies(trustedProxies []string) ServerOpt
  • func WriteTimeout(timeout time.Duration) ServerOpt
• type ValidationError
  • func BindBody(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

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

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

	// IdleTimeout is a timeout used when creating underlying http server (see 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
	// 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 IdleTimeout

func IdleTimeout(timeout time.Duration) ServerOpt

IdleTimeout is a timeout used when creating underlying http server (see http.Server).

func Network

func Network(network string) ServerOpt

Network is a network type for the listener.

func ReadTimeout

func ReadTimeout(timeout time.Duration) ServerOpt

ReadTimeout is a timeout used when creating underlying http server (see 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) 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 WriteTimeout

func WriteTimeout(timeout time.Duration) ServerOpt

WriteTimeout is a timeout used when creating underlying http server (see 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"`
}

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 ExtractValidatorErrors

func ExtractValidatorErrors(err error) []ValidationError

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