http

Documentation

Index

• Constants
• Variables
• func AsRouteGroup(handler any) any
• func RegisterRoutes(routes []RouteGroup, server *Http)
• type Configuration
• type Http
  • func NewEcho(config Configuration, log *zap.Logger, lc fx.Lifecycle) *Http
  • func (h *Http) DisableDebugging()
  • func (h *Http) EnableDebugging()
  • func (h *Http) Use(middleware echo.MiddlewareFunc)
• type RouteGroup
• type TLSOptions

Constants

const GROUP_ROUTES = `group:"httproutes"`

Variables

var Module = fx.Module(
	"http",
	fx.Invoke(
		fx.Annotate(
			RegisterRoutes,
			fx.ParamTags(GROUP_ROUTES),
		),
	),
	fx.Provide(
		NewEcho,
	),
)

Functions

func AsRouteGroup

func AsRouteGroup(handler any) any

func RegisterRoutes

func RegisterRoutes(routes []RouteGroup, server *Http)

Types

type Configuration

type Configuration struct {
	Address   string      `hcl:"address"`
	Ratelimit int         `hcl:"rate_limit"`
	Debug     bool        `hcl:"debug"`
	TLS       *TLSOptions `hcl:"tls,block"`
}

type Http

type Http struct {
	Address string
	Engine  *echo.Echo
}

func NewEcho

func NewEcho(config Configuration, log *zap.Logger, lc fx.Lifecycle) *Http

func (*Http) DisableDebugging

func (h *Http) DisableDebugging()

func (*Http) EnableDebugging

func (h *Http) EnableDebugging()

func (*Http) Use

func (h *Http) Use(middleware echo.MiddlewareFunc)

type RouteGroup

type RouteGroup interface {
	ApiGroup() string
	Version() string
	Handler(*echo.Group)
}

type TLSOptions

type TLSOptions struct {
	CertFile string `hcl:"cert_file"`
	KeyFile  string `hcl:"key_file"`
}