rest

Documentation

Index

• func RegisterService(ctx *cli.Context, baseService service.Service) (service.Service, error)
• type Service
  • func NewService(ctx *cli.Context, baseService *service.BaseService) (*Service, error)
  • func ToRESTService(service service.Service) *Service
  • func (s *Service) Dependencies() map[service.DependencyName]service.Option
  • func (s *Service) GenerateSpecs() error
  • func (s *Service) RegisterNamespaces() error
  • func (s *Service) Start(network utils.Network, networkId utils.NetworkID) error
  • func (s *Service) Stop() error

Functions

func RegisterService

func RegisterService(ctx *cli.Context, baseService service.Service) (service.Service, error)

Types

type Service

type Service struct {
	*service.BaseService
}

Service represents the REST service and embeds the BaseService.

func NewService

func NewService(ctx *cli.Context, baseService *service.BaseService) (*Service, error)

NewService creates and returns a new REST service instance, registering namespaces.

func ToRESTService

func ToRESTService(service service.Service) *Service

func (*Service) Dependencies

func (s *Service) Dependencies() map[service.DependencyName]service.Option

Dependencies injects the service dependencies for the REST service.

func (*Service) GenerateSpecs

func (s *Service) GenerateSpecs() error

GenerateSpecs generates and writes OpenAPI specifications in both JSON and YAML formats.

func (*Service) RegisterNamespaces

func (s *Service) RegisterNamespaces() error

func (*Service) Start

func (s *Service) Start(network utils.Network, networkId utils.NetworkID) error

Start initializes and starts the REST service, using an errgroup to manage goroutines.

func (*Service) Stop

func (s *Service) Stop() error

Stop stops the REST service.