Documentation
¶
Index ¶
- Constants
- func GetIrisContext(ctx context.Context) iris.Context
- func GetUserData(ctx context.Context) interface{}
- func OapiRequestValidator(swagger *openapi3.T) iris.Handler
- func OapiRequestValidatorWithOptions(swagger *openapi3.T, options *Options) iris.Handler
- func OapiValidatorFromYamlFile(path string) (iris.Handler, error)
- func ValidateRequestFromContext(ctx iris.Context, router routers.Router, options *Options) error
- type ErrorHandler
- type MultiErrorHandler
- type Options
Constants ¶
const ( IrisContextKey = "oapi-codegen/iris-context" UserDataKey = "oapi-codegen/user-data" )
Variables ¶
This section is empty.
Functions ¶
func GetIrisContext ¶
GetIrisContext gets the iris context from within requests. It returns nil if not found or wrong type.
func GetUserData ¶
func OapiRequestValidator ¶
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 ¶
OapiRequestValidatorWithOptions creates a validator from a swagger object, with validation options
func OapiValidatorFromYamlFile ¶
OapiValidatorFromYamlFile creates a validator middleware from a YAML file path
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
// SilenceServersWarning allows silencing a warning for https://github.com/ula/oapi-codegen/issues/882 that reports when an OpenAPI spec has `spec.Servers != nil`
SilenceServersWarning bool
}
Options to customize request validation. These are passed through to openapi3filter.
Source Files