server

Documentation

Index

• Variables
• type Error
• type Server
  • func New(cfg *config.Config, spoty *spoty.Spoty) *Server
  • func (s *Server) RegisterRoutes()
  • func (s *Server) Start() error
  • func (s *Server) Stop(ctx context.Context) error
• type Success

Variables

var Module = fx.Options(
	fx.Provide(New),
)

Module exported for initialising a new Server.

Types

type Error

type Error struct {
	Error string `json:"error"`
}

Error defines the structure for a failed response.

type Server

type Server struct {
	// contains filtered or unexported fields
}

Server is the main HTTP server.

func New

func New(cfg *config.Config, spoty *spoty.Spoty) *Server

New creates a new Server.

func (*Server) RegisterRoutes

func (s *Server) RegisterRoutes()

RegisterRoutes registers the REST HTTP routes.

func (*Server) Start

func (s *Server) Start() error

Start starts the server. It blocks until the server stops.

func (*Server) Stop

func (s *Server) Stop(ctx context.Context) error

Stop stops the server.

type Success

type Success struct {
	Success string `json:"success"`
}

Success defines the structure for a successful response.