package
0.35.0
Repository: https://github.com/sourcesoft/kin-openapi.git
Documentation: pkg.go.dev

# Functions

DefaultErrorEncoder writes the error to the ResponseWriter, by default a content type of text/plain, a body of the plain text of the error, and a status code of 500.
FileBodyDecoder is a body decoder that decodes a file body to a string.
NewRouter creates a new router.
No description provided by the author
RegisterBodyDecoder registers a request body's decoder for a content type.
TrimJSONPrefix trims one of the possible prefixes.
UnregisterBodyDecoder dissociates a body decoder from a content type.
ValidateParameter validates a parameter's value by JSON schema.
ValidateRequest is used to validate the given input according to previous loaded OpenAPIv3 spec.
ValidateRequestBody validates data of a request's body.
ValidateResponse is used to validate the given input according to previous loaded OpenAPIv3 spec.
ValidateSecurityRequirements goes through multiple OpenAPI 3 security requirements in order and returns nil on the first valid requirement.

# Constants

KindInvalidFormat describes an error that happens when a value does not conform a format that is required by a serialization method.
KindOther describes an untyped parsing error.
KindUnsupportedFormat describes an error that happens when a value has an unsupported format.

# Variables

No description provided by the author
No description provided by the author
ErrInvalidRequired is an error that happens when a required value of a parameter or request's body is not defined.
No description provided by the author

# Structs

No description provided by the author
No description provided by the author
ParseError describes errors which happens while parse operation's parameters, requestBody, or response.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Router maps a HTTP request to an OpenAPI operation.
No description provided by the author
ValidationError struct provides granular error information useful for communicating issues back to end user and developer.
ValidationErrorEncoder wraps a base ErrorEncoder to handle ValidationErrors.
ValidationErrorSource struct.
No description provided by the author

# Interfaces

Headerer is checked by DefaultErrorEncoder.
StatusCoder is checked by DefaultErrorEncoder.

# Type aliases

No description provided by the author
BodyDecoder is an interface to decode a body of a request or response.
A ContentParameterDecoder takes a parameter definition from the swagger spec, and the value which we received for it.
EncodingFn is a function that returns an encoding of a request body's part.
ErrorEncoder is responsible for encoding an error to the ResponseWriter.
ParseErrorKind describes a kind of ParseError.
Routers maps a HTTP request to a Router.