http

Documentation

Index

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

Constants

const (
	ComponentName string = "http-server"
)

Variables

var ErrUnknownComponent = fmt.Errorf("component is not the %s component", ComponentName)

var (
	ErrUnknownMethod error = fmt.Errorf("unknown http method")
)

Functions

func WithRequestLogger

func WithRequestLogger() components.Option

func WithRoute

func WithRoute(route Route) components.Option

func WithServerPort

func WithServerPort(port int) components.Option

Types

type Component

type Component struct {
	components.Base
	// contains filtered or unexported fields
}

func New

func New() *Component

func (*Component) Configure

func (c *Component) Configure(opts ...components.Option) error

func (*Component) RegisterRoute

func (c *Component) RegisterRoute(route Route) error

func (*Component) RegisterRoutes

func (c *Component) RegisterRoutes(routes ...Route) error

func (*Component) Router

func (c *Component) Router() *gin.Engine

func (*Component) Shutdown

func (c *Component) Shutdown() error

func (*Component) Start

func (c *Component) Start() error

type Route

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