irismiddleware

package module
v1.2.1 Latest Latest
Warning

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

Go to latest
Published: Oct 23, 2026 License: Apache-2.0 Imports: 11 Imported by: 2

README

Iris Middleware

⚠️ This README may be for the latest development version, which may contain unreleased changes. Please ensure you're looking at the README for the latest release version.

Middleware for the Iris web server for use with oapi-codegen.

Licensed under the Apache-2.0.

Validated request body

The middleware enables kin-openapi's openapi3filter.Options.KeepValidatedValue by default. After a request body passes validation, the body that handlers see (ctx.Request().Body) exposes the decoded value that was validated through a ValidatedValue() any method, and remains readable with its original bytes. An oapi-codegen strict server can bind that value instead of decoding the body a second time, so the handler receives exactly what was validated.

To turn this off, for instance to limit memory retention for very large request bodies, set DiscardValidatedValue: true in Options. This setting overrides Options.Options.KeepValidatedValue.

Middleware that replaces the request body after the validator has run (decompression, size limiting, logging wrappers and the like) hides the validated value from handlers. Register such middleware before the validator.

Documentation

Index

Constants

View Source
const (
	IrisContextKey = "oapi-codegen/iris-context"
	UserDataKey    = "oapi-codegen/user-data"
)

Variables

This section is empty.

Functions

func GetIrisContext

func GetIrisContext(ctx context.Context) iris.Context

GetIrisContext gets the iris context from within requests. It returns nil if not found or wrong type.

func GetUserData

func GetUserData(ctx context.Context) interface{}

func OapiRequestValidator

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

OapiRequestValidator is a iris 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

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

OapiRequestValidatorWithOptions creates a validator from a swagger object, with validation options

func OapiValidatorFromYamlFile

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

OapiValidatorFromYamlFile creates a validator middleware from a YAML file path

func ValidateRequestFromContext

func ValidateRequestFromContext(ctx iris.Context, router routers.Router, options *Options) error

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

Types

type ErrorHandler

type ErrorHandler func(ctx iris.Context, message string, statusCode int)

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
	// SilenceServersWarning allows silencing a warning for https://github.com/deepmap/oapi-codegen/issues/882 that reports when an OpenAPI spec has `spec.Servers != nil`
	SilenceServersWarning bool
	// DiscardValidatedValue turns off openapi3filter.Options.KeepValidatedValue,
	// which this middleware enables by default. With it enabled, the request body
	// seen by handlers exposes the value that was validated through a
	// ValidatedValue() method, 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.

Jump to

Keyboard shortcuts

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