The authority to use to access the endpoints

Format of the response entity carrying the client errors.

Convert the ClientErrors type into the endpoints4s internal client error type

Convert the endpoints4s internal client error type into the ClientErrors type

The scheme to use to access the endpoints

Format of the response entity carrying the server error.

Convert the ServerError type into the endpoints4s internal server error type

Turns a JsonCodec[A] into a Codec[String, A]

Convert the endpoints4s internal server error type into the ServerError type

Add the provided headers to the request.

Add the provided queryString to the request.

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.

Query string parameter containing a Boolean value

A request entity carrying chunks of Array[Byte] values

A response entity carrying chunks of Array[Byte] values

Chains the two paths

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

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 endpoints4s when decoding a request fails.

The provided implementation forwards to badRequest.

Concatenates two QueryStrings

Helper method to perform DELETE request

Codec for query string parameters of type Double

Path segment codec for type Double

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.

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.

Define an HTTP endpoint

Helper method to perform GET request

Ability to define Int query string parameters

Path segment codec for type Int

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

A request entity carrying chunks of JSON values

A response entity carrying chunks of JSON values

Request with a JSON body, given an implicit JsonRequest[A]

• Server interpreters accept requests with content-type application/json and reject requests with an incorrect content-type.
• Client interpreters supply content-type application/json

Defines a Response[A] given an implicit JsonResponse[A]

Query string parameter containing a Long value

Path segment codec for type Long

Map the inner documentation of the endpoint to new documentation.

Map the inner request of the endpoint to a new request. This is for example useful to add Auth headers to an existing endpoint.

Map the inner response of the endpoint to a new response. This is for example useful so you can add error handling to an existing endpoint.

Frames are delimited by a new-line separator

OK (200) Response with the given entity

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

Examples:

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

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, 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.

Helper method to perform PATCH request

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.

Request for given parameters

Provides the operations xmap and xmapPartial.

A required request header

Provides the operations xmap and xmapPartial.

Provides ++ operation.

Provides the operations xmap and xmapPartial.

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

Provides xmap operation.

Provides ++ operation.

Provides the operation xmap to the type Response

A path segment carrying an A information

Provides xmap and xmapPartial operations.

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

The provided implementation forwards to internalServerError

A path segment whose value is the given segment

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.

A request entity carrying chunks of String values

A response entity carrying chunks of String values

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

Text response entity

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

Provides xmap and xmapPartial operations

Builds an URL from the given path and query string

Ability to define UUID query string parameters

Path segment codec for type UUID

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

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