http

Documentation

Index

• Constants
• Variables
• func WithRequestLogger() modules.Option
• func WithRoute(route Route) modules.Option
• func WithServerPort(port int) modules.Option
• type Module
  • func New() *Module
  • func (m *Module) Configure(opts ...modules.Option) error
  • func (m *Module) RegisterRoute(route Route) error
  • func (m *Module) RegisterRoutes(routes ...Route) error
  • func (m *Module) Router() *gin.Engine
  • func (m *Module) Shutdown() error
  • func (m *Module) Start() error
• type Route

Constants

const (
	ModuleName string = "http-server"
)

Variables

var (
	ErrUnknownMethod error = fmt.Errorf("unknown http method")
	ErrUnknownModule       = fmt.Errorf("module is not the %s module", ModuleName)
)

Functions

func WithRequestLogger

func WithRequestLogger() modules.Option

Deprecated: this option has no effect, the module is always logging and setting the request logger, regardless if this options is used or not and will be removed in future.

func WithRoute

func WithRoute(route Route) modules.Option

func WithServerPort

func WithServerPort(port int) modules.Option

Types

type Module

type Module struct {
	modules.Base
	// contains filtered or unexported fields
}

func New

func New() *Module

func (*Module) Configure

func (m *Module) Configure(opts ...modules.Option) error

func (*Module) RegisterRoute

func (m *Module) RegisterRoute(route Route) error

func (*Module) RegisterRoutes

func (m *Module) RegisterRoutes(routes ...Route) error

func (*Module) Router

func (m *Module) Router() *gin.Engine

func (*Module) Shutdown

func (m *Module) Shutdown() error

func (*Module) Start

func (m *Module) Start() error

type Route

type Route struct {
	Group      string
	Handler    gin.HandlerFunc
	URI        string
	HTTPMethod string
}