server

Documentation

Index

• Variables
• func AsService(f any) any
• func InjectToHeaders(tracer *tracesdk.TracerProvider) gin.HandlerFunc
• func NewEngine(p EngineParams) (*gin.Engine, error)
• type EngineParams
• type HTTPServer
• type Params
• type Result
  • func New(p Params) (Result, error)
• type Service

Variables

var HTTPEngineModule = fx.Module("httpengine",
	fx.Provide(
		NewEngine,
	),
	fx.Decorate(wrapLogger),
)

var HTTPServerModule = fx.Module("httpserver",
	fx.Provide(
		New,
	),
	fx.Decorate(wrapLogger),
)

Functions

func AsService

func AsService(f any) any

AsService annotates the given constructor to state that it provides a HTTP service to the "httpservices" group.

func InjectToHeaders

func InjectToHeaders(tracer *tracesdk.TracerProvider) gin.HandlerFunc

func NewEngine

func NewEngine(p EngineParams) (*gin.Engine, error)

Types

type EngineParams

type EngineParams struct {
	fx.In

	Logger   *zap.Logger
	Config   *config.Config
	DB       *sql.DB
	TP       *tracesdk.TracerProvider
	TokenMgr *auth.TokenMgr

	Services []Service `group:"httpservices"`

	GRPCSrv *grpc.Server
}

type HTTPServer

type HTTPServer *http.Server

type Params

type Params struct {
	fx.In

	LC fx.Lifecycle

	Logger *zap.Logger
	Config *config.Config
	Engine *gin.Engine
}

type Result

type Result struct {
	fx.Out

	Server HTTPServer
}

func New

func New(p Params) (Result, error)

New builds an HTTP server that will begin serving requests when the Fx application starts.

type Service

type Service interface {
	RegisterHTTP(e *gin.Engine)
}