Responses

Extension methods for Response.

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

An HTTP response (status, headers, and entity) carrying an information of type A

Values of type Response[A] can be constructed by using the operations ok, badRequest, internalServerError, or the more general operation response.

An HTTP response entity carrying an information of type A

Values of type ResponseEntity can be constructed by using the operations emptyResponse or textResponse. Additional types of response entities are provided by other algebra modules, such as JsonEntities or ChunkedEntities.

Information carried by responses’ headers.

You can construct values of type ResponseHeaders by using the operations responseHeader, optResponseHeader, or emptyResponseHeaders.

HTTP Status Code

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.

Empty response entity

• Server interpreters produce no response entity,
• Client interpreters ignore the response entity.

No particular response header.

• Client interpreters should ignore information carried by response headers.

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.

Define an HTTP response

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

Text response entity

• Server interpreters produce an HTTP response with a text/plain content type.

Add the provided headers to the response.

Note that if the response describes a choice of several possible responses (resulting from the orElse operation), the headers will be added to all the possible responses.

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

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

OK (200) Response with the given entity

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

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

Extension methods for Response.

Provides xmap operation.

Provides ++ operation.

Provides the operation xmap to the type Response

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