Information carried by an HTTP endpoint
Information carried by an HTTP endpoint
Information carried by a multiplexed HTTP endpoint.
An URL path carrying an A
information
An URL path carrying an A
information
Convenient methods for Paths.
A query string carrying an A
information
A query string carrying an A
information
Provides convenient methods on QueryString.
Provides convenient methods on QueryString.
A single query string parameter carrying an A
information.
A single query string parameter carrying an A
information.
Information carried by a whole request (headers and entity)
Information carried by a whole request (headers and entity)
Information carried by request entity
Information carried by request entity
Information carried by requests’ headers
Information carried by requests’ headers
Information carried by a response
Information carried by a response
An URL path segment carrying an A
information.
An URL path segment carrying an A
information.
An URL carrying an A
information
An URL carrying an A
information
Chains the two paths
Chains the two paths
Concatenates two QueryString
s
Concatenates two QueryString
s
No particular information.
No particular information. Does not mean that the headers *have to* be empty. Just that, from a server point of view no information will be extracted from them, and from a client point of view no particular headers will be built in the request.
Empty request.
Empty request.
Empty response.
Empty response.
HTTP endpoint.
HTTP endpoint.
Request
Response
optional summary documentation
optional description documentation
list of OpenApi tags
Ability to define Int
query string parameters
Ability to define Int
query string parameters
Ability to define Int
path segments
Ability to define Int
path segments
Query string parameter containing a Long
value
Query string parameter containing a Long
value
Segment containing a Long
value
Segment containing a Long
value
Multiplexed HTTP endpoint.
Multiplexed HTTP endpoint.
A multiplexing endpoint makes it possible to use several request and response types in the same HTTP endpoint. In other words, it allows to define several different actions through a singe HTTP endpoint.
The base type of possible requests
The base type of possible responses
The data type used to transport the requests and responses
The request
The response
Builds a QueryString
with one optional parameter of type A
.
Builds a QueryString
with one optional parameter of type A
.
Parameter’s name
Turns a Response[A]
into a Response[Option[A]]
.
Turns a Response[A]
into a Response[Option[A]]
.
Concrete interpreters should represent None
with
an empty HTTP response whose status code is 404 (Not Found).
Builds a QueryString
with one parameter.
Builds a QueryString
with one parameter.
Type of the value carried by the parameter
Parameter’s name
Request for given parameters
Builds a path segment carrying an A
information
Builds a path segment carrying an A
information
Builds a static path segment
Builds a static path segment
Ability to define String
query string parameters
Ability to define String
query string parameters
Ability to define String
path segments
Ability to define String
path segments
Request with string body.
Request with string body.
Text response.
Text response.
Builds an URL from the given path and query string
Builds an URL from the given path and query string
Implicit conversion to get rid of intellij errors when defining paths.
Implicit conversion to get rid of intellij errors when defining paths. Effectively should not be called.
Helper method to perform GET request
Helper method to perform GET request
Payload carried by url
Payload carried by headers
An empty path.
An empty path.
Useful to begin a path definition:
path / "foo" / segment[Int] /? qs[String]("bar")
Helper method to perform POST request
Algebra interface for describing endpoints such that one endpoint can handle several types of requests and responses.