httpconfig

Documentation

Overview

This module handles basic configuration of HTTP server. It provides a function for reading environment variables and can set up a logger.

Index

• func EnvGet[T any](name string, def T, parse func(string) (T, error)) (T, error)
• func LogMiddleware(next http.Handler) http.Handler
• type CfgLog
  • func (cfg *CfgLog) Config() error
• type CfgServer
  • func (cfg *CfgServer) Config() error
  • func (cfg *CfgServer) GetServer(mux *http.ServeMux) *http.Server

Functions

func EnvGet

func EnvGet[T any](name string, def T, parse func(string) (T, error)) (T, error)

A function used for reading environment variables. It accepts a variable name, a default value, and a parsing function. This parsing function accepts a string (the raw representation of the environment variable) and returns a parsed value and an error.

func LogMiddleware

func LogMiddleware(next http.Handler) http.Handler

This middleware logs http request data at debug level.

Types

type CfgLog

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

A configuration struct for the logger, populated from environmental variables.

func (*CfgLog) Config

func (cfg *CfgLog) Config() error

This method configures logging by reading values from the following environmental variables: - LOG_LEVEL: Minimum log level for emitted messages. Can be any value of slog.Level. - LOG_SOURCE - boolean value - defines if log should contain source code position of the log statement.

type CfgServer

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

A configuration struct for the HTTP server, populated from environmental variables.

func (*CfgServer) Config

func (cfg *CfgServer) Config() error

This method configures HTTP server by reading values from the following environmental variables: - ADDRESS: TCP address for the server to listen on. Defaults to 0.0.0.0 - PORT - Specifies TCP port for the server to listen on. Defaults to 8080

func (*CfgServer) GetServer

func (cfg *CfgServer) GetServer(mux *http.ServeMux) *http.Server

This method returns *http.Server based on provided mux and configuration parsed with Config method.