webserver

package module

v0.0.0-...-2293720 Latest Latest Go to latest Published: Oct 9, 2023 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Bootstrap the creation of a HTTP(S) web server.

This section is empty.

This section is empty.

This section is empty.

type Config struct {
	Addr string    `json:"address"`
	Port int       `json:"port"`
	TLS  TLSConfig `json:"tls"`
}

Config ...

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

Server is a wrapper around http.Server that provides a graceful shutdown and other helpful features.

func NewServer(cfg Config) *Server

NewServer creates a new server.

func (s *Server) GetLogger() *slog.Logger

GetLogger returns the logger for the server.

func (s *Server) Router() *mux.Router

Router returns the router for the server.

func (s *Server) Run() error

Run the web server (blocking).

func (s *Server) SetLogger(l *slog.Logger)

SetLogger sets the logger for the server.

func (s *Server) Start()

Start the web server asynchronously (does not block).

func (s *Server) Stop() error

Stop gracefully stops the server.

type TLSConfig struct {
	Enabled  bool   `json:"enabled"`
	CertFile string `json:"certPath"`
	KeyFile  string `json:"keyPath"`
}

TLSConfig ...