lib

package

v0.0.0-...-f8930f8 Latest Latest Go to latest Published: Jan 21, 2024 License: MIT Imports: 12 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

View Source

const (
	DBHost = "Host"

	DBUsername = "User"

	DBPass = "Pass"

	DBPort = "Port"

	Development = "Development"
)

View Source

const (
	Port = 8081
)

This section is empty.

func CORSMiddleware(nextHandler http.HandlerFunc) http.HandlerFunc

func GNUMiddleware(nextHandler http.HandlerFunc) http.HandlerFunc

GNUMiddleware adds the X-Clacks-Overhead header to keep names alive (https://wiki.lspace.org/GNU_Terry_Pratchett)

func GetLogger(cfg *Config) *zap.Logger

func GetQueryId(r *http.Request, key string) (int, error)

func WriteError(log *zap.Logger, w http.ResponseWriter, statusCode int, err error, logMsg, errMsg string)

func WriteJson(log *zap.Logger, w http.ResponseWriter, marshalled []byte)

type ApiRouter interface {
	GetRoutes() []*Route
}

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

func NewConfig(requiredConfigs ...string) (*Config, error)

func (c *Config) Get(key string) (string, error)

func (c *Config) Populate(requiredConfigs []string) error

func (c *Config) Set(key, value string)

type DBClient struct {
	Db *sqlx.DB
	// contains filtered or unexported fields
}

func NewDBClient(cfg *Config, log *zap.Logger) (*DBClient, error)

func (d *DBClient) CheckConnection() error

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

func NewDBError(query string, innerErr error) *DBError

func (d *DBError) Error() string

type MiddlewareFunc func(nextHandler http.HandlerFunc) http.HandlerFunc

type Route struct {
	Path       string
	Method     string
	Handler    http.HandlerFunc
	MiddleWare MiddlewareFunc
}

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

func NewWebServer(cfg *Config, log *zap.Logger, setupRoutes func(router *mux.Router)) *Server

func (s *Server) Serve() error