Urls
Algebra interface for describing URLs made of a path and a query string.
A path is itself made of segments chained together.
A query string is made of named parameters.
/**
* Describes an URL starting with a segment containing “articles”, followed
* by another `String` segment, and a query string containing
* a mandatory `Lang` parameter named “lang”, and an
* optional `Int` parameter named “page”.
*
* Examples of matching URLs:
*
* - /articles/kitchen?lang=fr
* - /articles/garden?lang=en&page=2
*/
val example = path / "articles" / segment[String]() /? (qs[Lang]("lang") & qs[Option[Int]]("page"))
Type members
Inherited classlikes
Extension methods for values of type F[A]
for which there is an implicit
InvariantFunctor[F]
instance.
Extension methods for values of type F[A]
for which there is an implicit
InvariantFunctor[F]
instance.
- Inherited from:
- InvariantFunctorSyntax
- Inherited from:
- PartialInvariantFunctorSyntax
Types
An URL path carrying an A
information
An URL path carrying an A
information
Values of type Path[A]
can be constructed by the operations path,
segment, and remainingSegments.
path / "user" / segment[UUID]("id")
- Server interpreters raise an error if they can’t parse the incoming
request path as a value of type
A
. By default, they produce a Bad Request (400) response with a list of error messages in a JSON array. Refer to the documentation of your server interpreter to customize this behavior.
- Note:
This type has implicit methods provided by the PathOps, InvariantFunctorSyntax, and the PartialInvariantFunctorSyntax classes.
A query string carrying an A
information
A query string carrying an A
information
QueryString values can be created with the qs operation,
and can be combined with the &
operation:
val queryPageAndLang: QueryString[(Int, Option[String])] =
qs[Int]("page") & qs[Option[String]]("lang")
- Server interpreters raise an error if they can’t parse the incoming
request query string parameters as a value of type
A
. By default, they produce a Bad Request (400) response with a list of error messages in a JSON array. Refer to the documentation of your server interpreter to customize this behavior.
- Note:
This type has implicit methods provided by the QueryStringSyntax, InvariantFunctorSyntax, and the PartialInvariantFunctorSyntax classes.
A query string parameter codec for type A
.
A query string parameter codec for type A
.
The trait Urls
provides implicit instances of type QueryStringParam[A]
for basic types (e.g., Int
, String
, etc.). You can create additional
instances by transforming or refining the existing instances with xmap
and xmapPartial
.
- Note:
This type has implicit methods provided by the PartialInvariantFunctorSyntax and the InvariantFunctorSyntax classes.
An URL path segment codec for type A
.
An URL path segment codec for type A
.
The trait Urls
provides implicit instances of Segment[A]
for basic types
(e.g., Int
, String
, etc.). You can create additional instances by transforming
or refining the existing instances with xmap
and xmapPartial
.
- Note:
This type has implicit methods provided by the PartialInvariantFunctorSyntax and the InvariantFunctorSyntax classes.
An URL carrying an A
information
An URL carrying an A
information
Values of type URL[A]
are typically constructed by first using the path
constructor and then chaining it with segments and query parameters.
path / "users" / segment[UUID]("id") /? qs[String]("apiKey")
- Server interpreters raise an error if they can’t parse the incoming
request URL as a value of type
A
. By default, they produce a Bad Request (400) response with a list of error messages in a JSON array. Refer to the documentation of your server interpreter to customize this behavior.
- Note:
This type has implicit methods provided by the PartialInvariantFunctorSyntax and InvariantFunctorSyntax classes.
This type is necessary to express different perspectives of servers and clients on optional query string parameters with default value:
This type is necessary to express different perspectives of servers and clients on optional query string parameters with default value:
- Client interpreters should define it as
Option[A]
and omit query string parameters with default value that are empty - Server interpreters should define it as
A
and accept incoming requests whose query string parameters with default value are missing, while providing the defined default value - Documentation interpreters should mark the parameter as optional and document the provided default value
Value members
Abstract methods
Concatenates two QueryString
s
Concatenates two QueryString
s
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 parameters:
- A
Type of the value carried by the parameter
- Value parameters:
- name
Parameter’s name
The remaining segments of the path. The String
value carried by this Path
is still URL-encoded.
The remaining segments of the path. The String
value carried by this Path
is still URL-encoded.
Builds an URL from the given path and query string
Builds an URL from the given path and query string
Concrete methods
Builds a QueryString
with one optional parameter, which has a default value.
Builds a QueryString
with one optional parameter, which has a default value.
Examples:
optQsWithDefault[Int]("page", 1) // optional `page` parameter, with default value 1
- Type parameters:
- A
Type of the value carried by the parameter
- Value parameters:
- name
Parameter’s name
Implicits
Implicits
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, and they must report a failure for incoming requests whose optional query string parameters are present, but malformed,
- Documentation interpreters should mark the parameter as optional.
Provides xmap
and xmapPartial
operations.
Provides xmap
and xmapPartial
operations.
- See also:
PartialInvariantFunctorSyntax and InvariantFunctorSyntax
Provides xmap
and xmapPartial
operations.
Provides xmap
and xmapPartial
operations.
- See also:
PartialInvariantFunctorSyntax and InvariantFunctorSyntax
Provides xmap
and xmapPartial
operations.
Provides xmap
and xmapPartial
operations.
- See also:
PartialInvariantFunctorSyntax and InvariantFunctorSyntax
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.
Provides xmap
and xmapPartial
operations.
Provides xmap
and xmapPartial
operations.
- See also:
PartialInvariantFunctorSyntax and InvariantFunctorSyntax
Path segment codec for type String
Path segment codec for type String
- Server interpreters should return an URL-decoded string value,
- Client interpreters should take an URL-decoded string value.
Provides xmap
and xmapPartial
operations
Provides xmap
and xmapPartial
operations
- See also:
PartialInvariantFunctorSyntax and InvariantFunctorSyntax
Inherited implicits
Extension methods for values of type F[A]
for which there is an implicit
InvariantFunctor[F]
instance.
Extension methods for values of type F[A]
for which there is an implicit
InvariantFunctor[F]
instance.
- Inherited from:
- InvariantFunctorSyntax
- Inherited from:
- PartialInvariantFunctorSyntax