algebra
API
Generated with
algebra/endpoints4s/endpoints4s.algebra/Urls

Urls

endpoints4s.algebra.Urls
trait Urls extends PartialInvariantFunctorSyntax

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"))

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Requests
trait Assets
trait Endpoints
trait JsonEntities
trait JsonCodecs
trait MuxEndpoints
Show all

Members list

Type members

Classlikes

implicit class PathOps[A](first: Path[A])

Convenient methods for Paths.

Convenient methods for Paths.

Attributes

Supertypes
class Object
trait Matchable
class Any
implicit class QueryStringSyntax[A](first: QueryString[A])

Extension methods on QueryString.

Extension methods on QueryString.

Attributes

Supertypes
class Object
trait Matchable
class Any

Inherited classlikes

implicit class InvariantFunctorSyntax[A, F[_]](val fa: F[A])(implicit ev: InvariantFunctor[F])

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.

Attributes

Inherited from:
InvariantFunctorSyntax
Supertypes
class Object
trait Matchable
class Any
implicit class PartialInvariantFunctorSyntax[A, F[_]](val fa: F[A])(implicit ev: PartialInvariantFunctor[F])

Attributes

Inherited from:
PartialInvariantFunctorSyntax
Supertypes
class Object
trait Matchable
class Any

Types

type Path[A] <: Url[A]

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.

Attributes

Note

This type has implicit methods provided by the PathOps, InvariantFunctorSyntax, and the PartialInvariantFunctorSyntax classes.

type QueryString[A]

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.

Attributes

Note

This type has implicit methods provided by the QueryStringSyntax, InvariantFunctorSyntax, and the PartialInvariantFunctorSyntax classes.

type QueryStringParam[A]

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.

Attributes

Note

This type has implicit methods provided by the PartialInvariantFunctorSyntax and the InvariantFunctorSyntax classes.

type Segment[A]

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.

Attributes

Note

This type has implicit methods provided by the PartialInvariantFunctorSyntax and the InvariantFunctorSyntax classes.

type Url[A]

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.

Attributes

Note

This type has implicit methods provided by the PartialInvariantFunctorSyntax and InvariantFunctorSyntax classes.

type WithDefault[A]

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

Attributes

Value members

Abstract methods

def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]

Chains the two paths

Chains the two paths

Attributes

def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]

Concatenates two QueryStrings

Concatenates two QueryStrings

Attributes

def qs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[A]

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

Attributes

def remainingSegments(name: String, docs: Documentation): Path[String]

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.

Attributes

def segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]

A path segment carrying an A information

A path segment carrying an A information

Attributes

def staticPathSegment(segment: String): Path[Unit]

A path segment whose value is the given segment

A path segment whose value is the given segment

Attributes

def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]

Builds an URL from the given path and query string

Builds an URL from the given path and query string

Attributes

Concrete methods

def optQsWithDefault[A](name: String, default: A, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[WithDefault[A]]

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

Attributes

Concrete fields

val path: Path[Unit]

An empty path.

An empty path.

Useful to begin a path definition:

 path / "foo" / segment[Int] /? qs[String]("bar")

Attributes

Implicits

Implicits

final implicit def PathOps[A](first: Path[A]): PathOps[A]

Convenient methods for Paths.

Convenient methods for Paths.

Attributes

final implicit def QueryStringSyntax[A](first: QueryString[A]): QueryStringSyntax[A]

Extension methods on QueryString.

Extension methods on QueryString.

Attributes

implicit def booleanQueryString: QueryStringParam[Boolean]

Query string parameter containing a Boolean value

Query string parameter containing a Boolean value

Attributes

implicit def doubleQueryString: QueryStringParam[Double]

Codec for query string parameters of type Double

Codec for query string parameters of type Double

Attributes

implicit def doubleSegment: Segment[Double]

Path segment codec for type Double

Path segment codec for type Double

Attributes

implicit def intQueryString: QueryStringParam[Int]

Ability to define Int query string parameters

Ability to define Int query string parameters

Attributes

implicit def intSegment: Segment[Int]

Path segment codec for type Int

Path segment codec for type Int

Attributes

implicit def longQueryString: QueryStringParam[Long]

Query string parameter containing a Long value

Query string parameter containing a Long value

Attributes

implicit def longSegment: Segment[Long]

Path segment codec for type Long

Path segment codec for type Long

Attributes

implicit def optionalQueryStringParam[A : QueryStringParam]: QueryStringParam[Option[A]]

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.

Attributes

implicit def pathPartialInvariantFunctor: PartialInvariantFunctor[Path]

Provides xmap and xmapPartial operations.

Provides xmap and xmapPartial operations.

Attributes

See also

PartialInvariantFunctorSyntax and InvariantFunctorSyntax

implicit def queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]

Provides xmap and xmapPartial operations.

Provides xmap and xmapPartial operations.

Attributes

See also

PartialInvariantFunctorSyntax and InvariantFunctorSyntax

implicit def queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]

Provides xmap and xmapPartial operations.

Provides xmap and xmapPartial operations.

Attributes

See also

PartialInvariantFunctorSyntax and InvariantFunctorSyntax

implicit def repeatedQueryStringParam[A : QueryStringParam, CC <: (Iterable)](implicit evidence$2: QueryStringParam[A], factory: Factory[A, CC[A]]): QueryStringParam[CC[A]]

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.

Attributes

implicit def segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]

Provides xmap and xmapPartial operations.

Provides xmap and xmapPartial operations.

Attributes

See also

PartialInvariantFunctorSyntax and InvariantFunctorSyntax

implicit def stringQueryString: QueryStringParam[String]

Ability to define String query string parameters

Ability to define String query string parameters

Attributes

implicit def stringSegment: Segment[String]

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.

Attributes

implicit def urlPartialInvariantFunctor: PartialInvariantFunctor[Url]

Provides xmap and xmapPartial operations

Provides xmap and xmapPartial operations

Attributes

See also

PartialInvariantFunctorSyntax and InvariantFunctorSyntax

implicit def uuidQueryString: QueryStringParam[UUID]

Ability to define UUID query string parameters

Ability to define UUID query string parameters

Attributes

implicit def uuidSegment: Segment[UUID]

Path segment codec for type UUID

Path segment codec for type UUID

Attributes

Inherited implicits

final implicit def InvariantFunctorSyntax[A, F[_]](fa: F[A])(implicit ev: InvariantFunctor[F]): InvariantFunctorSyntax[A, F]

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.

Attributes

Inherited from:
InvariantFunctorSyntax
final implicit def PartialInvariantFunctorSyntax[A, F[_]](fa: F[A])(implicit ev: PartialInvariantFunctor[F]): PartialInvariantFunctorSyntax[A, F]

Attributes

Inherited from:
PartialInvariantFunctorSyntax
Generated with