SumTypedEntitiesTestApi

Extension methods for Endpoint.

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.

Extension methods for Request.

Extension methods for Response.

Callbacks indexed by URL pattern

Information carried by an HTTP endpoint

Values of type Endpoint can be constructed by using the operation endpoint.

A JSON codec type class

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.

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.

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.

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.

HTTP Status Code

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

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.

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 entity format for Invalid values

Concatenates two QueryStrings

Helper method to perform DELETE request

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

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

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]

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.

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.

Helper method to perform PATCH request

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

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

Request for given parameters

A required request 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")
     )
   )

A path segment carrying an A information

Response entity format for Throwable values

A path segment whose value is the given segment

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

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.

Builds an URL from the given path and query string

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

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

Response used by endpoints4s when decoding a request fails.

The provided implementation forwards to badRequest.

An empty path.

Useful to begin a path definition:

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

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

The provided implementation forwards to internalServerError

Extension methods for Endpoint.

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.

Extension methods for Request.

Extension methods for Response.

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 the operations xmap and xmapPartial.

Provides the operations xmap and xmapPartial.

Provides ++ operation.

Provides the operations xmap and xmapPartial.

Provides xmap operation.

Provides ++ operation.

Provides the operation xmap to the type Response

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