Documentation
¶
Overview ¶
Package middleware implements middleware function for server implementations, which validates incoming HTTP requests to make sure that they conform to the given OAPI 3.0 specification. When OAPI validation fails on the request, we return an HTTP/400.
Index ¶
- Constants
- 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(c fiber.Ctx, router routers.Router, options *Options) error
- func ValidatedBody(c fiber.Ctx) (any, bool)
- type ErrorHandler
- type MultiErrorHandler
- type Options
Constants ¶
const ValidatedBodyLocalsKey = "x-oapi-codegen-validated-body"
ValidatedBodyLocalsKey is the c.Locals key under which the middleware stores the decoded request body value that passed validation (see Options.DiscardValidatedValue). The value is what kin-openapi validated: nil, bool, string, json.Number, []any or map[string]any.
Strict servers generated by oapi-codegen look the value up under this same key, where it is defined independently so generated code does not import this module. Keep the two in sync.
Variables ¶
This section is empty.
Functions ¶
func GetFiberContext ¶
GetFiberContext gets the fiber context from within requests. It returns nil if not found or wrong type.
func GetUserData ¶
func OapiRequestValidator ¶
OapiRequestValidator is a fiber middleware function which validates incoming HTTP requests to make sure that they conform to the given OAPI 3.0 specification. When OAPI validation fails on the request, we return an HTTP/400 with error message
func OapiRequestValidatorWithOptions ¶
OapiRequestValidatorWithOptions creates a validator from a swagger object, with validation options
func OapiValidatorFromYamlFile ¶
OapiValidatorFromYamlFile creates a validator middleware from a YAML file path
func ValidateRequestFromContext ¶
ValidateRequestFromContext is called from the middleware above and actually does the work of validating a request.
Types ¶
type ErrorHandler ¶
ErrorHandler is called when there is an error in validation
type MultiErrorHandler ¶
type MultiErrorHandler func(openapi3.MultiError) error
MultiErrorHandler is called when oapi returns a MultiError type
type Options ¶
type Options struct {
Options openapi3filter.Options
ErrorHandler ErrorHandler
ParamDecoder openapi3filter.ContentParameterDecoder
UserData interface{}
MultiErrorHandler MultiErrorHandler
// DiscardValidatedValue turns off openapi3filter.Options.KeepValidatedValue,
// which this middleware enables by default. With it enabled, the decoded
// request body value that passed validation is stored in the Fiber context
// under ValidatedBodyLocalsKey, so a handler (for example an oapi-codegen
// strict server) can bind that value instead of decoding the body a second
// time. Set this to drop the decoded value after validation, for instance to
// limit memory retention for very large request bodies.
//
// Options.Options.KeepValidatedValue is overridden by this setting.
DiscardValidatedValue bool
}
Options to customize request validation. These are passed through to openapi3filter.