rest

package

v1.0.0 Latest Latest Go to latest Published: May 29, 2024 License: MIT Imports: 23 Imported by: 0

Details

This section is empty.

This section is empty.

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

type Service struct {
	*service.BaseService
}

Service represents the REST service and embeds the BaseService.

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

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

func ToRESTService(service service.Service) *Service

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

Dependencies injects the service dependencies for the REST service.

func (s *Service) GenerateSpecs() error

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

func (s *Service) RegisterNamespaces() error

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 (s *Service) Stop() error

Stop stops the REST service.