fiber

package
v2.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 20, 2022 License: BSD-3-Clause Imports: 7 Imported by: 0

README

Fiber (webserver)

Setting up the preconfigured webserver:

app := fx.New(
	env.Module,
	logrus.Module,
	metrics.Module,
	fiber.Module,
)
app.Run()

It will integrate logging, metrics and basic error handling into your webserver app.

Error handling

func useFiber(app *fiber.App) {
	app.Get("/path", func(ctx *fiber.Ctx) error {
		// whenever you return a `fiber.Error`:
		// - the status code will be set automatically
		// - the error will be logged
		// - and the error string wil be returned in the response body
		return fiber.NewFiberError(errors.New("your error"), fiber.StatusBadRequest)
	})
}

Middleware usage

If you want to add middleware to your fiber app, you can do this like in the following:

func newMiddlewareMap() *MiddlewareHandlerMap {
	return &MiddlewareHandlerMap{
		// fiber supports middleware restriction to paths. Use an empty string for global middleware.
		// all middleware will be initialized in the same order that it is defined.
		"/path": []fiber.Handler{
			func(ctx *fiber.Ctx) error {
				// your middleware code here
				return ctx.Next()
			},
		},
	}
}
Predefined middleware
  • middleware.NoCors() middleware that disables CORS for development environments

Documentation

Index

Constants

This section is empty.

Variables

View Source
var Module = fx.Options(
	fx.Provide(
		newFiber,
	),
	fx.Invoke(
		useFiber,
	),
)

Functions

This section is empty.

Types

type Error

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

func NewError

func NewError(err error, statusCode int) *Error

func (*Error) Error

func (e *Error) Error() string

func (*Error) StatusCode

func (e *Error) StatusCode() int

type FiberParams

type FiberParams struct {
	fx.In

	Logger     *logrus.Logger
	Middleware *MiddlewareHandlerMap `optional:"true"`
}

type MiddlewareHandlerMap

type MiddlewareHandlerMap map[string][]fiber.Handler

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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