api

Documentation

Index

• type AuthMiddlewareType
• type Server
  • func New(config *config.Config, services service.Services, zapLog *zap.Logger) Server
  • func (s *Server) StartWithContext(ctx context.Context)
  • func (s *Server) Stop(ctx context.Context)

Types

type AuthMiddlewareType

type AuthMiddlewareType = string

const (
	UserAuth  AuthMiddlewareType = "USER"
	AdminAuth AuthMiddlewareType = "ADMIN"
)

type Server

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

Server is the struct that represents the API server

func New

func New(config *config.Config,
	services service.Services,
	zapLog *zap.Logger,
) Server

New is used to create a new instance of the API server

func (*Server) StartWithContext

func (s *Server) StartWithContext(ctx context.Context)

func (*Server) Stop

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

Stop shutdown the API server. It waits for StartWithContext to return (servers drained) or for ctx to be done.