serverfiber

README

go-server-fiber

Fiber servers for go-services

Documentation

Index

• type FiberConfig
  • func (config *FiberConfig) GetBindAddress() string
• type FiberServer
  • func NewFiberServer(config ServerFiberConfig, initializer Initializer) *FiberServer
  • func (server *FiberServer) Close(_ context.Context) error
  • func (server *FiberServer) Listen(_ context.Context) error
  • func (server *FiberServer) Name() string
  • func (server *FiberServer) WithConfig(config ServerFiberConfig) *FiberServer
  • func (server *FiberServer) WithFiberConfig(config *fiber.Config) *FiberServer
  • func (server *FiberServer) WithName(name string) *FiberServer
• type Initializer
• type ServerFiberConfig
• type ViperConfig
  • func (config *ViperConfig) GetBindAddress() string
  • func (config ViperConfig) WithPrefix(prefix string) ViperConfig
  • func (config ViperConfig) WithViper(v *viper.Viper) ViperConfig

Types

type FiberConfig

type FiberConfig struct {
	BindAddress string
}

FiberConfig is the in-memory implementation of the ServerFiberConfig.

func (*FiberConfig) GetBindAddress

func (config *FiberConfig) GetBindAddress() string

type FiberServer

type FiberServer struct {
	// contains filtered or unexported fields
}

FiberServer represents the services.Server for fiber applications.

func NewFiberServer

func NewFiberServer(config ServerFiberConfig, initializer Initializer) *FiberServer

NewFiberServer returns a new instance of FiberServer initialized.

func (*FiberServer) Close

func (server *FiberServer) Close(_ context.Context) error

func (*FiberServer) Listen

func (server *FiberServer) Listen(_ context.Context) error

func (*FiberServer) Name

func (server *FiberServer) Name() string

func (*FiberServer) WithConfig

func (server *FiberServer) WithConfig(config ServerFiberConfig) *FiberServer

WithConfig initializes the ServerFiberConfig that will be used to start the fiber.App.

func (*FiberServer) WithFiberConfig

func (server *FiberServer) WithFiberConfig(config *fiber.Config) *FiberServer

func (*FiberServer) WithName

func (server *FiberServer) WithName(name string) *FiberServer

WithName will initialize the name of the service.

type Initializer

type Initializer func(app *fiber.App) error

Initializer is a function that will receive the fiber.App instance with the objetive of initialize its middlewares and routes.

type ServerFiberConfig

type ServerFiberConfig interface {
	GetBindAddress() string
}

ServerFiberConfig defines the configuration contract to be used on the FiberServer.

type ViperConfig

type ViperConfig struct {
	// contains filtered or unexported fields
}

ViperConfig implements ServerFiberConfig using github.com/spf13/viper.

func (*ViperConfig) GetBindAddress

func (config *ViperConfig) GetBindAddress() string

func (ViperConfig) WithPrefix

func (config ViperConfig) WithPrefix(prefix string) ViperConfig

WithPrefix returns a copy of ViperConfig with the prefix set.

func (ViperConfig) WithViper

func (config ViperConfig) WithViper(v *viper.Viper) ViperConfig

WithViper returns a copy of ViperConfig with the base viper.Viper instance (used to read all configuration from) set.