service

README

Framework base for all services

Documentation

Index

• func HandleWithTransaction(http *httpserver.HttpServer, trxItf transaction.TransactionInterface, ...) gin.HandlerFunc
• func NewValidator() (*validation.Validator, error)
• func Run(serviceName string, options Options, ...)
• func WithTransaction(ctx context.Context, fn func(db *gorm.DB) error) error
• type BaseService
  • func (bs *BaseService) GetDatabase() (*database.Database, error)
  • func (bs *BaseService) GetHttpServer() (*httpserver.HttpServer, error)
  • func (bs *BaseService) GetMqPublisher() (*events.Publisher, error)
  • func (bs *BaseService) GetMqSubscriber() (*events.Subscriber, error)
• type Options
• type ServiceStartPointMetrics
• type WrappedHandlerFunc

Functions

func HandleWithTransaction

func HandleWithTransaction(http *httpserver.HttpServer, trxItf transaction.TransactionInterface, handler WrappedHandlerFunc) gin.HandlerFunc

func NewValidator

func NewValidator() (*validation.Validator, error)

func Run

func Run(serviceName string, options Options, serviceLogic func(ctx context.Context, baseService *BaseService) error)

func WithTransaction

func WithTransaction(ctx context.Context, fn func(db *gorm.DB) error) error

Types

type BaseService

type BaseService struct {
	Config *config.Config
	Probe  *health.Probe

	Validator *validation.Validator

	Environment env.Environment
	// contains filtered or unexported fields
}

func (*BaseService) GetDatabase

func (bs *BaseService) GetDatabase() (*database.Database, error)

func (*BaseService) GetHttpServer

func (bs *BaseService) GetHttpServer() (*httpserver.HttpServer, error)

func (*BaseService) GetMqPublisher

func (bs *BaseService) GetMqPublisher() (*events.Publisher, error)

func (*BaseService) GetMqSubscriber

func (bs *BaseService) GetMqSubscriber() (*events.Subscriber, error)

type Options

type Options struct {
	UseDatabase bool
	UseEvents   bool
}

type ServiceStartPointMetrics

type ServiceStartPointMetrics struct {
	metricsDomain.BaseMetric

	Start int `metric:"start"`
}

TODO: Determine if we should add the version and commit hash to metrics

type WrappedHandlerFunc

type WrappedHandlerFunc func(*gin.Context) (any, error)