Documentation
¶
Index ¶
- Variables
- func FileBodyDecoder(body io.Reader, header http.Header, schema *openapi3.SchemaRef, ...) (interface{}, error)
- func RegisterBodyDecoder(contentType string, decoder BodyDecoder)
- func RegisterBodyEncoder(contentType string, encoder BodyEncoder)
- func UnregisterBodyDecoder(contentType string)
- func UnregisterBodyEncoder(contentType string)
- func ValidateParameter(ctx context.Context, input *openapi3filter.RequestValidationInput, ...) error
- func ValidateRequest(ctx context.Context, input *openapi3filter.RequestValidationInput, ...) (err error)
- func ValidateRequestBody(ctx context.Context, input *openapi3filter.RequestValidationInput, ...) error
- func ValidateResponse(ctx context.Context, input *openapi3filter.ResponseValidationInput, ...) error
- func ValidateSecurityRequirements(ctx context.Context, input *openapi3filter.RequestValidationInput, ...) error
- type BodyDecoder
- type BodyEncoder
- type EncodingFn
- type ParseError
- type ParseErrorKind
- type RequestUnknownParameterError
Constants ¶
This section is empty.
Variables ¶
var ErrAuthenticationServiceMissing = errors.New("missing AuthenticationFunc")
ErrAuthenticationServiceMissing is returned when no authentication service is defined for the request validator
var ErrDecodingFailed = errors.New("the decoder returned the error")
ErrDecodingFailed is returned when the API FW got error or unexpected value from the decoder
var ErrInvalidEmptyValue = errors.New("empty value is not allowed")
ErrInvalidEmptyValue is returned when a value of a parameter or request body is empty while it's not allowed.
var ErrInvalidRequired = errors.New("value is required but missing")
ErrInvalidRequired is returned when a required value of a parameter or request body is not defined.
var ErrUnknownBodyParameter = errors.New("body parameter not defined in the OpenAPI specification")
ErrUnknownBodyParameter is returned when a body parameter not defined in the OpenAPI specification.
var ErrUnknownContentType = errors.New("unknown content type of the request body")
ErrUnknownContentType is returned when the API FW can't parse the request body
var ErrUnknownQueryParameter = errors.New("query parameter not defined in the OpenAPI specification")
ErrUnknownQueryParameter is returned when a query parameter not defined in the OpenAPI specification.
Functions ¶
func FileBodyDecoder ¶
func FileBodyDecoder(body io.Reader, header http.Header, schema *openapi3.SchemaRef, encFn EncodingFn, jsonParser *fastjson.Parser) (interface{}, error)
FileBodyDecoder is a body decoder that decodes a file body to a string.
func RegisterBodyDecoder ¶
func RegisterBodyDecoder(contentType string, decoder BodyDecoder)
RegisterBodyDecoder registers a request body's decoder for a content type.
If a decoder for the specified content type already exists, the function replaces it with the specified decoder. This call is not thread-safe: body decoders should not be created/destroyed by multiple goroutines.
func RegisterBodyEncoder ¶
func RegisterBodyEncoder(contentType string, encoder BodyEncoder)
func UnregisterBodyDecoder ¶
func UnregisterBodyDecoder(contentType string)
UnregisterBodyDecoder dissociates a body decoder from a content type.
Decoding this content type will result in an error. This call is not thread-safe: body decoders should not be created/destroyed by multiple goroutines.
func UnregisterBodyEncoder ¶
func UnregisterBodyEncoder(contentType string)
This call is not thread-safe: body encoders should not be created/destroyed by multiple goroutines.
func ValidateParameter ¶
func ValidateParameter(ctx context.Context, input *openapi3filter.RequestValidationInput, parameter *openapi3.Parameter) error
ValidateParameter validates a parameter's value by JSON schema. The function returns RequestError with a ParseError cause when unable to parse a value. The function returns RequestError with ErrInvalidRequired cause when a value of a required parameter is not defined. The function returns RequestError with ErrInvalidEmptyValue cause when a value of a required parameter is not defined. The function returns RequestError with a openapi3.SchemaError cause when a value is invalid by JSON schema.
func ValidateRequest ¶
func ValidateRequest(ctx context.Context, input *openapi3filter.RequestValidationInput, jsonParser *fastjson.Parser) (err error)
ValidateRequest is used to validate the given input according to previous loaded OpenAPIv3 spec. If the input does not match the OpenAPIv3 spec, a non-nil error will be returned.
Note: One can tune the behavior of uniqueItems: true verification by registering a custom function with openapi3.RegisterArrayUniqueItemsChecker
func ValidateRequestBody ¶
func ValidateRequestBody(ctx context.Context, input *openapi3filter.RequestValidationInput, requestBody *openapi3.RequestBody, jsonParser *fastjson.Parser) error
ValidateRequestBody validates data of a request's body.
The function returns RequestError with ErrInvalidRequired cause when a value is required but not defined. The function returns RequestError with a openapi3.SchemaError cause when a value is invalid by JSON schema.
func ValidateResponse ¶
func ValidateResponse(ctx context.Context, input *openapi3filter.ResponseValidationInput, jsonParser *fastjson.Parser) error
ValidateResponse is used to validate the given input according to previous loaded OpenAPIv3 spec. If the input does not match the OpenAPIv3 spec, a non-nil error will be returned.
Note: One can tune the behavior of uniqueItems: true verification by registering a custom function with openapi3.RegisterArrayUniqueItemsChecker
func ValidateSecurityRequirements ¶
func ValidateSecurityRequirements(ctx context.Context, input *openapi3filter.RequestValidationInput, srs openapi3.SecurityRequirements) error
ValidateSecurityRequirements goes through multiple OpenAPI 3 security requirements in order and returns nil on the first valid requirement. If no requirement is met, errors are returned in order.
Types ¶
type BodyDecoder ¶
type BodyDecoder func(io.Reader, http.Header, *openapi3.SchemaRef, EncodingFn, *fastjson.Parser) (interface{}, error)
BodyDecoder is an interface to decode a body of a request or response. An implementation must return a value that is a primitive, []interface{}, or map[string]interface{}.
func RegisteredBodyDecoder ¶
func RegisteredBodyDecoder(contentType string) BodyDecoder
RegisteredBodyDecoder returns the registered body decoder for the given content type.
If no decoder was registered for the given content type, nil is returned. This call is not thread-safe: body decoders should not be created/destroyed by multiple goroutines.
type BodyEncoder ¶
func RegisteredBodyEncoder ¶
func RegisteredBodyEncoder(contentType string) BodyEncoder
RegisteredBodyEncoder returns the registered body encoder for the given content type.
If no encoder was registered for the given content type, nil is returned. This call is not thread-safe: body encoders should not be created/destroyed by multiple goroutines.
type EncodingFn ¶
EncodingFn is a function that returns an encoding of a request body's part.
type ParseError ¶
type ParseError struct {
Kind ParseErrorKind
Value interface{}
Reason string
Cause error
// contains filtered or unexported fields
}
ParseError describes errors which happens while parse operation's parameters, requestBody, or response.
func (*ParseError) Error ¶
func (e *ParseError) Error() string
func (*ParseError) Path ¶
func (e *ParseError) Path() []interface{}
Path returns a path to the root cause.
func (*ParseError) RootCause ¶
func (e *ParseError) RootCause() error
RootCause returns a root cause of ParseError.
func (ParseError) Unwrap ¶
func (e ParseError) Unwrap() error
type ParseErrorKind ¶
type ParseErrorKind int
ParseErrorKind describes a kind of ParseError. The type simplifies comparison of errors.
const ( // KindOther describes an untyped parsing error. KindOther ParseErrorKind = iota // KindUnsupportedFormat describes an error that happens when a value has an unsupported format. KindUnsupportedFormat // KindInvalidFormat describes an error that happens when a value does not conform a format // that is required by a serialization method. KindInvalidFormat )
type RequestUnknownParameterError ¶
type RequestUnknownParameterError struct {
Input *openapi3filter.RequestValidationInput
Parameters []string
RequestBody *openapi3.RequestBody
Err error
}
RequestUnknownParameterError is returned by ValidateRequest when request does not match OpenAPI spec
func ValidateUnknownRequestParameters ¶
func ValidateUnknownRequestParameters(ctx *fasthttp.RequestCtx, route *routers.Route, header http.Header, jsonParser *fastjson.Parser) (foundUnknownParams []RequestUnknownParameterError, valError error)
ValidateUnknownRequestParameters is used to get a list of request parameters that are not specified in the OpenAPI specification
Source Files