Bad Request (400) response, with an entity of type ClientErrors.

Query string parameter containing a Boolean value

Chains the two paths

Alternative between two possible choices of responses.

Server interpreters construct either one or the other response. Client interpreters accept either one or the other response. Documentation interpreters list all the possible responses.

Response used by the endpoints library when decoding a request fails.

The provided implementation forwards to badRequest.

Response entity format for Invalid values

Convert the ClientErrors type into the endpoints internal client error type

Concatenates two QueryStrings

Helper method to perform DELETE request

Codec for query string parameters of type Double

Segment codec for type Double

Implicit conversion to get rid of intellij errors when defining paths. Effectively should not be called.

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

Always succeeds in extracting no information from the headers

An empty response entity

No particular response header. Client interpreters should ignore information carried by response headers.

HTTP endpoint.

Helper method to perform GET request

This method is called by endpoints when decoding a request failed.

The provided implementation calls clientErrorsResponse to construct a response containing the errors.

This method can be overridden to customize the error reporting logic.

This method is called by endpoints when an exception is thrown during request processing.

The provided implementation calls serverErrorResponse to construct a response containing the error message.

This method can be overridden to customize the error reporting logic.

A successful HTTP response (status code 200) with an HTML entity

Ability to define Int query string parameters

Ability to define Int path segments

Internal Server Error (500) response, with an entity of type ServerError.

Convert the endpoints internal client error type into the ClientErrors type

Query string parameter containing a Long value

Segment containing a Long value

OK (200) Response with the given entity

An optional request header

Response headers optionally containing a header with the given name. Client interpreters should model the header value as Some[String], or None if the response header is missing. Server interpreters should produce such a response header. Documentation interpreters should document this header.

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.

An empty path.

Useful to begin a path definition:

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

Provides xmap and xmapPartial operations.

Helper method to perform POST request

Helper method to perform PUT request

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

Provides xmap and xmapPartial operations.

Provides xmap and xmapPartial operations.

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

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.

Decodes a request.

Provides the operations xmap and xmapPartial.

A required request header

Provides the operations xmap and xmapPartial.

Provides ++ operation.

Provides the operations xmap and xmapPartial.

Server interpreters construct a response with the given status and entity. Client interpreters accept a response only if it has a corresponding status code.

Response headers containing a header with the given name. Client interpreters should model the header value as String, or fail if the response header is missing. Server interpreters should produce such a response header. Documentation interpreters should document this header.

Example:

val versionedResource: Endpoint[Unit, (SomeResource, String)] =
  endpoint(
    get(path / "versioned-resource"),
    ok(
      jsonResponse[SomeResource],
      headers = responseHeader("ETag")
    )
  )

Provides xmap operation.

Provides ++ operation.

Provides the operation xmap to the type Response

Builds a Play router out of endpoint definitions.

val routes = routesFromEndpoints(
  inc.implementedBy(x => x + 1)
)

A path segment carrying an A information

Provides xmap and xmapPartial operations.

Response used by the endpoints library when the business logic of an endpoint fails.

The provided implementation forwards to internalServerError

Response entity format for Throwable values

Convert the ServerError type into the endpoints internal server error type

A path segment whose value is the given segment

Ability to define String query string parameters

Ability to define String path segments Servers should return an URL-decoded string value, and clients should take an URL-decoded string value.

Request with a String body.

A text entity

Convert the endpoints internal server error type into the ServerError type

Provides xmap and xmapPartial operations

Builds an URL from the given path and query string

Ability to define UUID query string parameters

Ability to define UUID path segments

Turns a Response[A] into a Response[Option[A]].

Interpreters represent None with an empty HTTP response whose status code is 404 (Not Found).