http

Documentation

Index

• type HTTPServerOptions
• type Option
  • func WithHTTPServerAppName(appName string) Option
  • func WithHTTPServerBodyLimit(bodyLimit int) Option
  • func WithHTTPServerCaseSensitive(isCaseSensitive bool) Option
  • func WithHTTPServerHeader(header string) Option
  • func WithHTTPServerReadTimeout(readTimeout time.Duration) Option
  • func WithHTTPServerStrictRouting(isStrictRouting bool) Option
  • func WithHTTPServerWriteTimeout(writeTimeout time.Duration) Option
• type Server
  • func NewHTTPServer(opts ...Option) *Server

Types

type HTTPServerOptions

type HTTPServerOptions struct {
	ServerHeader string
	AppName      string

	CaseSensitive bool
	StrictRouting bool
	ReadTimeout   time.Duration
	WriteTimeout  time.Duration
	BodyLimit     int
}

HTTPServerOptions defines the http server configuration

type Option

type Option func(*HTTPServerOptions)

Option is the func interface to assign options

func WithHTTPServerAppName

func WithHTTPServerAppName(appName string) Option

WithHTTPServerAppName defines the HTTPServer App Name

func WithHTTPServerBodyLimit

func WithHTTPServerBodyLimit(bodyLimit int) Option

WithHTTPServerBodyLimit defines the HTTPServer Body Limit

func WithHTTPServerCaseSensitive

func WithHTTPServerCaseSensitive(isCaseSensitive bool) Option

WithHTTPServerCaseSensitive defines the HTTPServer Case Sensitive

func WithHTTPServerHeader

func WithHTTPServerHeader(header string) Option

WithHTTPServerHeader defines the HTTPServer Header

func WithHTTPServerReadTimeout

func WithHTTPServerReadTimeout(readTimeout time.Duration) Option

WithHTTPServerReadTimeout defines the HTTPServer Read Timeout

func WithHTTPServerStrictRouting

func WithHTTPServerStrictRouting(isStrictRouting bool) Option

WithHTTPServerStrictRouting defines the HTTPServer Strict Routing

func WithHTTPServerWriteTimeout

func WithHTTPServerWriteTimeout(writeTimeout time.Duration) Option

WithHTTPServerWriteTimeout defines the HTTPServer Write Timeout

type Server

type Server struct {
	Options *HTTPServerOptions
	App     *fiber.App
}

func NewHTTPServer

func NewHTTPServer(opts ...Option) *Server

NewHTTP returns a new HTTP instance