schema

Documentation

Overview

Package schema contains DTOs describing services and

Index

• Variables
• type AddHandlersFunc
• type ProvidingServices
• type ServiceDefinition
• type ServiceID
• type ServiceInitFunc
• type ServiceMapping

Variables

var (
	// ErrInvalidType - error casting general service to exact type.
	ErrInvalidType = errors.New("invalid service type")

	// ErrMissingService - provider has no matching service to return.
	ErrMissingService = errors.New("provider missing initialized service")
)

Types

type AddHandlersFunc

type AddHandlersFunc func(baseGroup, secGroup *echo.Group) error

AddHandlersFunc - function adding handlers to secure or/and unsecure groups.

type ProvidingServices

type ProvidingServices interface {
	Service(id ServiceID) any
}

ProvidingServices describes provider of the services.

type ServiceDefinition

type ServiceDefinition struct {
	// Unique service ID allowing to build service dependency tree
	ID ServiceID
	// Init is a function used to initialized service instance with given state
	Init ServiceInitFunc
	// DependsOn list IDs of the required services.
	DependsOn []ServiceID
	// InitHandlersFunc is a function for initializing service-related handlers
	// after the service is initialized.
	// Can remain `nil` if service does not provide API endpoints.
	InitHandlersFunc func(state ProvidingServices) AddHandlersFunc
}

ServiceDefinition contains service metadata and initialization.

type ServiceID

type ServiceID string

ServiceID - ID of the service.

type ServiceInitFunc

type ServiceInitFunc func(ctx context.Context, state any) (any, error)

ServiceInitFunc - function returning initialized service instance.

type ServiceMapping

type ServiceMapping map[ServiceID]any

ServiceMapping - ServiceID to Service mapping.