Checks the presence of the named Api Key parameter.
Allows binding of a value to an entity (eg.
Allows binding of a value to an entity (eg. query/header/field...)
Represents the binding of a parameter to it's value in a particular context
Spec required to marshall a body of a custom type
Spec required to marshall a body of a custom type
the type of the parameter
Description to be used in the documentation
The HTTP content type header value
function to take the input string from the request and attempt to construct a deserialized instance. Exceptions are automatically caught and translated into the appropriate result, so just concentrate on the Happy-path case
function to take the input type and serialize it to a string to be represented in the request
Mechanism to extract (or fail to extract) an entity value from a particular 'From' context
Mechanism to extract (or fail to extract) a parameter from a particular 'From' context, adding
Represents a object which was provided and extracted successfully
Result of an attempt to extract an object from a target
Represents a object which could not be extracted due to it being invalid or missing when required
The body entity of a encoded HTML form.
The body entity of a encoded HTML form. Basically a wrapper for Form construction and field extraction.
Forms are effectively modelled as a collection of fields.
Support for parameters which can have more than one value (e.g query parameters or forms)
For optional Parameters, adds the ability to bind an Optional value as well as a concrete value
How a parameter is represented in the HTTP message (JSON type)
A parameter is a name-value pair which can be encoded into an HTTP message.
A parameter is a name-value pair which can be encoded into an HTTP message. Sub-types represent the various places in which values are encoded (eg. header/form/query/path)
Parameter location specific utility functions to assist with extraction and binding of values
Spec required to marshall and demarshall a parameter of a custom type
Spec required to marshall and demarshall a parameter of a custom type
the type of the parameter
optional description of the parameter (for use in description endpoints)
The parameter type to be used in the documentation. For custom types, this is usually ObjectParamType (for JSON) or StringParamType
function to take the input string from the request and attempt to construct a deserialized instance of T. Exceptions are automatically caught and translated into the appropriate result, so just concentrate on the Happy-path case
function to take the input type and serialize it to a string to be represented in the request
a parameter for retrieving a value of type [T] from the request
By implementing ParameterSpecSupplier[T], we can declare parameters using a shorthand: eg.
By implementing ParameterSpecSupplier[T], we can declare parameters using a shorthand: eg. Path(HipsterBeardStyle)
Prototype functions for creating parameters of various types.
Used to transparently copy the value out of an incoming request (or form etc..) and into an outgoing one.
Used to transparently copy the value out of an incoming request (or form etc..) and into an outgoing one. Useful when chaining requests together.
Represents the ability to retrieve a value from an enclosing object (request/form etc..)
Endpoint security.
Endpoint security. Provides filter to be applied to endpoints for all requests.
Represents a single entity which makes up the entirety of an HTTP message body.
Represents a single entity which makes up the entirety of an HTTP message body.
the type of the request when it has been deserialized from the request
Factory methods for various supported HTTP body types.
Parameters which are bound to request/response headers
Default NoOp security filter.
Default NoOp security filter. Filter allows all traffic through.
Represents an optional object which was not provided - this is still a non-failing case
Predefined ParameterSpec instances for common types
Parameters which are bound to the path segments of a URL
Parameters which are bound to the query part of a URL
Checks the presence of the named Api Key parameter. Filter returns 401 if Api-Key is not found in request.