middleware

Documentation

Index

• func DefaultSkipper(*fiber.Ctx) bool
• func GetFiberContext(c context.Context) *fiber.Ctx
• func GetUserData(c context.Context) interface{}
• func OapiRequestValidator(swagger *openapi3.T) fiber.Handler
• func OapiRequestValidatorWithOptions(swagger *openapi3.T, options *Options) fiber.Handler
• func OapiValidatorFromYamlFile(path string) (fiber.Handler, error)
• func ValidateRequestFromContext(ctx *fiber.Ctx, router routers.Router, options *Options) error
• type Options
• type Skipper

Functions

func DefaultSkipper

func DefaultSkipper(*fiber.Ctx) bool

DefaultSkipper returns false which processes the middleware.

func GetFiberContext

func GetFiberContext(c context.Context) *fiber.Ctx

Helper function to get the fiber context from within requests. It returns nil if not found or wrong type.

func GetUserData

func GetUserData(c context.Context) interface{}

func OapiRequestValidator

func OapiRequestValidator(swagger *openapi3.T) fiber.Handler

Create a validator from a swagger object.

func OapiRequestValidatorWithOptions

func OapiRequestValidatorWithOptions(swagger *openapi3.T, options *Options) fiber.Handler

Create a validator from a swagger object, with validation options

func OapiValidatorFromYamlFile

func OapiValidatorFromYamlFile(path string) (fiber.Handler, error)

Create validator middleware from a YAML file path

func ValidateRequestFromContext

func ValidateRequestFromContext(ctx *fiber.Ctx, router routers.Router, options *Options) error

ValidateRequestFromContext is called from the middleware above and actually does the work of validating a request.

Types

type Options

type Options struct {
	Options      openapi3filter.Options
	ParamDecoder openapi3filter.ContentParameterDecoder
	UserData     interface{}
	Skipper      Skipper
}

Options to customize request validation. These are passed through to openapi3filter.

type Skipper

type Skipper func(*fiber.Ctx) bool

Skipper defines a function to skip middleware. Returning true skips processing the middleware.