Requests

Extension methods for Request.

Extension methods for values of type F[A] for which there is an implicit InvariantFunctor[F] instance.

Convenient methods for Paths.

Extension methods on QueryString.

Information carried by a whole request (headers and entity)

Values of type Request[A] can be constructed by using the operations request, get, post, put, or delete.

• Server interpreters raise an error if they can’t parse the incoming request 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.

Information carried by request entity

Values of type RequestEntity[A] can be constructed by using the operations emptyRequest or textRequest. Additional types of request entities are provided by other algebra modules, such as JsonEntities or ChunkedEntities.

• Server interpreters raise an error if they can’t parse the incoming request entity 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.

Information carried by requests’ headers.

You can construct values of type RequestHeaders by using the operations requestHeader, optRequestHeader, or emptyRequestHeaders.

• Server interpreters raise an error if they can’t parse the incoming request headers 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.

HTTP Method

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.

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.

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.

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.

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.

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

Alternative between two possible request entities, differentiated by the Content-Type header

Empty request -- request without a body. Use description of endpoints4s.algebra.Endpoints#endpoint to document an empty body.

Ignore headers

• Server interpreters don’t try to parse any information from the request headers,
• Client interpreters supply no specific headers

Use description of endpoints4s.algebra.Endpoints#endpoint to document empty headers.

An optional request header

Request for given parameters

A required request header

Request with a String body.

• Server interpreters accept requests with content-type text/plain and reject requests with an incorrect content-type.
• Server interpreters will use the character encoding set in the content-type header to determine how the text is decoded.
• Client interpreters supply content-type text/plain with an explicit character encoding

Add the provided headers to the request.

Add the provided queryString to the request.

Helper method to perform DELETE request

Helper method to perform GET request

Helper method to perform PATCH request

Helper method to perform POST request

Helper method to perform PUT request

Chains the two paths

Concatenates two QueryStrings

Builds a QueryString with one optional parameter, which has a default value.

Examples:

 optQsWithDefault[Int]("page", 1) // optional `page` parameter, with default value 1

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

The remaining segments of the path. The String value carried by this Path is still URL-encoded.

A path segment carrying an A information

A path segment whose value is the given segment

Builds an URL from the given path and query string

An empty path.

Useful to begin a path definition:

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

Extension methods for Request.

Provides the operations xmap and xmapPartial.

Provides the operations xmap and xmapPartial.

Provides ++ operation.

Provides the operations xmap and xmapPartial.

Extension methods for values of type F[A] for which there is an implicit InvariantFunctor[F] instance.

Convenient methods for Paths.

Extension methods on QueryString.

Query string parameter containing a Boolean value

Codec for query string parameters of type Double

Path segment codec for type Double

Ability to define Int query string parameters

Path segment codec for type Int

Query string parameter containing a Long value

Path segment codec for type Long

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.

Provides xmap and xmapPartial operations.

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.

Ability to define String query string parameters

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

Ability to define UUID query string parameters

Path segment codec for type UUID