http

package

v1.0.2 Latest Latest Go to latest Published: Dec 31, 2022 License: GPL-3.0 Imports: 18 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

Repository

github.com/eminmuhammadi/memcache

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func ConfigureMiddleware(app *fiber.App)
func Create() *fiber.App
func CreateRoutes(db *gorm.DB, app *fiber.App)
func EnableCORS(app *fiber.App)
func EnableCompression(app *fiber.App)
func EnableETAG(app *fiber.App)
func EnableHealthCheck(app *fiber.App)
func EnableLogger(app *fiber.App)
func EnableMetrics(app *fiber.App)
func EnableMonitoring(app *fiber.App)
func EnableRecovers(app *fiber.App)
func EnableRequestID(app *fiber.App)
func ErrorHandler(ctx *fiber.Ctx, err error) error
func Start(app *fiber.App, db *gorm.DB, hostname string, port string) error
func StartSecure(app *fiber.App, db *gorm.DB, hostname string, port string, certFile string, ...) error

Constants ¶

View Source

const HEALTHCHECK_PATH = "/_/healthcheck"

The http path for healthcheck.

View Source

const INTERNAL_SERVER_ERROR string = "Internal Server Error"

This is a message that is sent when the server is down.

View Source

const METRICS_PATH = "/_/metrics"

The http path for metrics.

View Source

const MONITORING_PATH = "/_/monitoring"

The http path for monitoring.

View Source

const PROMETHEUS_SERVICE_NAME = "github.com/eminmuhammadi/memcache"

Prometheus service name.

Variables ¶

View Source

var APP_CONFIGURATION = fiber.Config{
	EnablePrintRoutes:     config.DefaultConfig.EnablePrintRoutes,
	ReduceMemoryUsage:     config.DefaultConfig.ReduceMemoryUsage,
	DisableStartupMessage: config.DefaultConfig.DisableStartupMessage,
	BodyLimit:             config.DefaultConfig.BodyLimit,
	Concurrency:           config.DefaultConfig.Concurrency,
	ReadBufferSize:        config.DefaultConfig.ReadBufferSize,
	WriteBufferSize:       config.DefaultConfig.WriteBufferSize,
	ReadTimeout:           time.Second * time.Duration(config.DefaultConfig.ReadTimeout),
	WriteTimeout:          time.Second * time.Duration(config.DefaultConfig.WriteTimeout),
	IdleTimeout:           time.Second * time.Duration(config.DefaultConfig.IdleTimeout),
	JSONEncoder:           json.Marshal,
	JSONDecoder:           json.Unmarshal,
	ErrorHandler:          ErrorHandler,
	Prefork:               config.DefaultConfig.Prefork,
}

App configuration.

Functions ¶

func ConfigureMiddleware ¶

func ConfigureMiddleware(app *fiber.App)

Default configuration for the middleware.

func Create ¶

func Create() *fiber.App

Create is a function that creates the app.

func CreateRoutes ¶

func CreateRoutes(db *gorm.DB, app *fiber.App)

CreateRoutes is a function that creates the routes.

func EnableCORS ¶

func EnableCORS(app *fiber.App)

It enables the cors middleware.

func EnableCompression ¶

func EnableCompression(app *fiber.App)

It enables the compression middleware.

func EnableETAG ¶

func EnableETAG(app *fiber.App)

It enables the etag middleware.

func EnableHealthCheck ¶

func EnableHealthCheck(app *fiber.App)

It enables the health check middleware.

func EnableLogger ¶

func EnableLogger(app *fiber.App)

It enables the logger middleware.

func EnableMetrics ¶

func EnableMetrics(app *fiber.App)

It enables the metrics middleware.

func EnableMonitoring ¶

func EnableMonitoring(app *fiber.App)

It enables the monitoring middleware.

func EnableRecovers ¶

func EnableRecovers(app *fiber.App)

It enables the recovery middleware.

func EnableRequestID ¶

func EnableRequestID(app *fiber.App)

It enables the request id middleware.

func ErrorHandler ¶

func ErrorHandler(ctx *fiber.Ctx, err error) error

ErrorHandler is the error handler for the app.

func Start ¶

func Start(app *fiber.App, db *gorm.DB, hostname string, port string) error

Start is a function that starts the app.

func StartSecure ¶

func StartSecure(app *fiber.App, db *gorm.DB, hostname string, port string, certFile string, keyFile string) error

StartSecure is a function that starts the app in secure mode.

Types ¶

This section is empty.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL