Endpoints
Related Doc:
package algebra
Information carried by an HTTP endpoint
HTTP Method
HTTP Method
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
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
Extensions for 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 QueryStrings
Concatenates two QueryStrings
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 path segments
Ability to define Int path segments
Segment containing a Long value
Segment containing a Long value
Make a query string parameter optional:
Make a query string parameter optional:
path / "articles" /? qs[Option[Int]]("page")
Client interpreters must omit optional query string parameters that are empty. Server interpreters must accept incoming requests whose optional query string parameters are missing. Server interpreters must report a failure for incoming requests whose optional query string parameters are present, but malformed.
Builds a QueryString with one parameter.
Builds a QueryString with one parameter.
Examples:
qs[Int]("page") // mandatory `page` parameter qs[Option[String]]("lang") // optional `lang` parameter qs[List[Long]]("id") // repeated `id` parameter
Type of the value carried by the parameter
Parameter’s name
Ability to refine a query string parameter for a type A
into a query string parameter for a type B given a pair
of decoding/encoding functions between A and B.
Ability to refine a query string parameter for a type A
into a query string parameter for a type B given a pair
of decoding/encoding functions between A and B.
The type of the available query string parameter.
The type of the desired query string parameter.
A query string parameter for a type A
Decoding function from A to Option[B]
Encoding function from B to A
A query string parameter for a type B built by refinement from pa.
Ability to refine a path segment for a type A
into a path segment for a type B given a pair
of decoding/encoding functions between A and B.
Ability to refine a path segment for a type A
into a path segment for a type B given a pair
of decoding/encoding functions between A and B.
The type of the available path segment.
The type of the desired path segment.
A path segment for a type A
Decoding function from A to Option[B]
Encoding function from B to A
A path segment for a type B built by refinement from sa.
Support query string parameters with multiple values:
Support query string parameters with multiple values:
path / "articles" /? qs[List[Long]]("id")
Server interpreters must accept incoming requests where such parameters are missing (in such a case, its value is an empty collection), and report a failure if at least one value is malformed.
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
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).
Query string parameter containing a Boolean value
Query string parameter containing a Boolean value
Helper method to perform DELETE request
Helper method to perform DELETE request
Payload carried by url
Payload carried by headers
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
Ability to define Int query string parameters
Ability to define Int query string parameters
Query string parameter containing a Long value
Query string parameter containing a Long value
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
Helper method to perform PUT request
Ability to define UUID query string parameters
Ability to define UUID query string parameters
Ability to define UUID path segments
Ability to define UUID path segments
Algebra interface for describing endpoints made of requests and responses.
Requests and responses contain headers and entity.