httpserver

Documentation

Overview

Package httpserver provides the HTTP/API server for RotomNG.

Index

• type Config
• type HTTPAPIHandler
• type HTTPServer
  • func NewHTTPServer(ctx context.Context, logger *slog.Logger, cfg Config) (*HTTPServer, error)
• type MetricsHandler

Types

type Config

type Config struct {
	Address        string
	Listener       net.Listener
	UIPath         string
	UIFS           *embed.FS
	DevMode        bool
	MetricsHandler MetricsHandler
	AuthMiddleware services.AuthMiddleware
	APIHandler     HTTPAPIHandler
	StatsRegistrar services.StatsRegistrar
}

Config holds configuration for the HTTP server.

type HTTPAPIHandler

type HTTPAPIHandler interface {
	SetupAPIRoutes(apiGroup *gin.RouterGroup)
	GetPrometheusEnabled() bool
	GetConfig(ginContext *gin.Context)
	ConfigReload(ginContext *gin.Context)
}

HTTPAPIHandler defines the interface for API route handlers.

type HTTPServer

type HTTPServer = services.WebServer

HTTPServer is a type alias for the generic web server.

func NewHTTPServer

func NewHTTPServer(ctx context.Context, logger *slog.Logger, cfg Config) (*HTTPServer, error)

NewHTTPServer creates a new HTTPServer instance with app-specific route setup.

type MetricsHandler

type MetricsHandler interface {
	GetMetricsHandler() http.Handler
}

MetricsHandler defines the interface for providing a metrics HTTP handler.