openapi3filter

package

Go to main page

Versions in this module

v0

v0.116.0

Mar 3, 2023

v0.115.0

Mar 3, 2023

Changes in this version

+ const ErrCodeCannotFindRoute

+ const ErrCodeOK

+ const ErrCodeRequestInvalid

+ const ErrCodeResponseInvalid

+ var ErrInvalidEmptyValue = errors.New("empty value is not allowed")

+ var ErrInvalidRequired = errors.New("value is required but missing")

+ func DefaultErrorEncoder(_ context.Context, err error, w http.ResponseWriter)

+ func FileBodyDecoder(body io.Reader, header http.Header, schema *openapi3.SchemaRef, ...) (interface{}, error)

+ func NoopAuthenticationFunc(context.Context, *AuthenticationInput) error

+ func RegisterBodyDecoder(contentType string, decoder BodyDecoder)

+ func RegisterBodyEncoder(contentType string, encoder BodyEncoder)

+ func UnregisterBodyDecoder(contentType string)

+ func UnregisterBodyEncoder(contentType string)

+ type AuthenticationFunc func(context.Context, *AuthenticationInput) error

+ type BodyDecoder func(io.Reader, http.Header, *openapi3.SchemaRef, EncodingFn) (interface{}, error)

+ func RegisteredBodyDecoder(contentType string) BodyDecoder

+ type BodyEncoder func(body interface{}) ([]byte, error)

+ func RegisteredBodyEncoder(contentType string) BodyEncoder

+ type ContentParameterDecoder func(param *openapi3.Parameter, values []string) (interface{}, *openapi3.Schema, error)

+ type CustomSchemaErrorFunc func(err *openapi3.SchemaError) string

+ type EncodingFn func(partName string) *openapi3.Encoding

+ type ErrCode int

+ type ErrFunc func(w http.ResponseWriter, status int, code ErrCode, err error)

+ type ErrorEncoder func(ctx context.Context, err error, w http.ResponseWriter)

+ type Headerer interface

+ Headers func() http.Header

+ type LogFunc func(message string, err error)

type Options

+ ExcludeReadOnlyValidations bool

+ ExcludeWriteOnlyValidations bool

+ MultiError bool

+ SkipSettingDefaults bool

+ func (o *Options) WithCustomSchemaErrorFunc(f CustomSchemaErrorFunc)

+ type ParseError struct

+ Cause error

+ Kind ParseErrorKind

+ Reason string

+ Value interface{}

+ func (e *ParseError) Error() string

+ func (e *ParseError) Path() []interface{}

+ func (e *ParseError) RootCause() error

+ func (e ParseError) Unwrap() error

+ type ParseErrorKind int

+ const KindInvalidFormat

+ const KindOther

+ const KindUnsupportedFormat

type RequestError

+ func (err RequestError) Unwrap() error

type RequestValidationInput

+ ParamDecoder ContentParameterDecoder

type ResponseError

+ func (err ResponseError) Unwrap() error

+ type StatusCoder interface

+ StatusCode func() int

+ type ValidationError struct

+ Code string

+ Detail string

+ Id string

+ Source *ValidationErrorSource

+ Status int

+ Title string

+ func (e *ValidationError) Error() string

+ func (e *ValidationError) StatusCode() int

+ type ValidationErrorEncoder struct

+ Encoder ErrorEncoder

+ func (enc *ValidationErrorEncoder) Encode(ctx context.Context, err error, w http.ResponseWriter)

+ type ValidationErrorSource struct

+ Parameter string

+ Pointer string

+ type ValidationHandler struct

+ AuthenticationFunc AuthenticationFunc

+ ErrorEncoder ErrorEncoder

+ File string

+ Handler http.Handler

+ func (h *ValidationHandler) Load() error

+ func (h *ValidationHandler) Middleware(next http.Handler) http.Handler

+ func (h *ValidationHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ type Validator struct

+ func NewValidator(router routers.Router, options ...ValidatorOption) *Validator

+ func (v *Validator) Middleware(h http.Handler) http.Handler

+ type ValidatorOption func(*Validator)

+ func OnErr(f ErrFunc) ValidatorOption

+ func OnLog(f LogFunc) ValidatorOption

+ func Strict(strict bool) ValidatorOption

+ func ValidationOptions(options Options) ValidatorOption

v0.1.0

Sep 29, 2018

Changes in this version

+ var DefaultJSONMediaTypes = []string

+ var DefaultOptions = &Options

+ var ErrAuthenticationServiceMissing = errors.New("Request validator doesn't have an authentication service defined")

+ var JSONPrefixes = []string

+ func TrimJSONPrefix(data []byte) []byte

+ func ValidateParameter(c context.Context, input *RequestValidationInput, ...) error

+ func ValidateRequest(c context.Context, input *RequestValidationInput) error

+ func ValidateRequestBody(c context.Context, input *RequestValidationInput, ...) error

+ func ValidateResponse(c context.Context, input *ResponseValidationInput) error

+ func ValidateSecurityRequirements(c context.Context, input *RequestValidationInput, ...) error

+ type AuthenticationInput struct

+ RequestValidationInput *RequestValidationInput

+ Scopes []string

+ SecurityScheme *openapi3.SecurityScheme

+ SecuritySchemeName string

+ func (input *AuthenticationInput) NewError(err error) error

+ type Options struct

+ AuthenticationFunc func(c context.Context, input *AuthenticationInput) error

+ ExcludeRequestBody bool

+ ExcludeResponseBody bool

+ IncludeResponseStatus bool

+ type RequestError struct

+ Err error

+ Input *RequestValidationInput

+ Parameter *openapi3.Parameter

+ Reason string

+ RequestBody *openapi3.RequestBody

+ Status int

+ func (err *RequestError) Error() string

+ func (err *RequestError) HTTPStatus() int

+ type RequestValidationInput struct

+ Options *Options

+ PathParams map[string]string

+ QueryParams url.Values

+ Request *http.Request

+ Route *Route

+ func (input *RequestValidationInput) GetQueryParams() url.Values

+ type ResponseError struct

+ Err error

+ Input *ResponseValidationInput

+ Reason string

+ func (err *ResponseError) Error() string

+ type ResponseValidationInput struct

+ Body io.ReadCloser

+ Header http.Header

+ Options *Options

+ RequestValidationInput *RequestValidationInput

+ Status int

+ func (input *ResponseValidationInput) SetBodyBytes(value []byte) *ResponseValidationInput

+ type Route struct

+ Handler http.Handler

+ Method string

+ Operation *openapi3.Operation

+ Path string

+ PathItem *openapi3.PathItem

+ Server *openapi3.Server

+ Swagger *openapi3.Swagger

+ type RouteError struct

+ Reason string

+ Route Route

+ func (err *RouteError) Error() string

+ type Router struct

+ func NewRouter() *Router

+ func (router *Router) AddRoute(route *Route) error

+ func (router *Router) AddSwagger(swagger *openapi3.Swagger) error

+ func (router *Router) AddSwaggerFromFile(path string) error

+ func (router *Router) FindRoute(method string, url *url.URL) (*Route, map[string]string, error)

+ func (router *Router) WithSwagger(swagger *openapi3.Swagger) *Router

+ func (router *Router) WithSwaggerFromFile(path string) *Router

+ type Routers []*Router

+ func (routers Routers) FindRoute(method string, url *url.URL) (*Router, *Route, map[string]string, error)

+ type SecurityRequirementsError struct

+ Errors []error

+ SecurityRequirements openapi3.SecurityRequirements

+ func (err *SecurityRequirementsError) Error() string

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