Endpoints
Interpreter for algebra.Endpoints that performs routing using Play framework, and uses algebra.BuiltInErrors to model client and server errors.
Consider the following endpoints definition:
trait MyEndpoints extends algebra.Endpoints with algebra.JsonEntities {
val inc = endpoint(get(path / "inc" ? qs[Int]("x")), jsonResponse[Int])
}
You can get a router for them as follows:
object MyRouter extends MyEndpoints with play.server.Endpoints with play.server.JsonEntities {
val routes = routesFromEndpoints(
inc.implementedBy(x => x + 1)
)
}
Then MyRouter.routes
can be used to define a proper Play router as follows:
val router = play.api.routing.Router.from(MyRouter.routes)
Attributes
- Graph
-
- Supertypes
-
trait BuiltInErrorstrait StatusCodestrait Methodstrait Urlstrait Endpointstrait BuiltInErrorstrait EndpointsWithCustomErrorstrait Errorstrait Responsestrait StatusCodestrait Requeststrait SemigroupalSyntaxtrait Methodstrait Urlstrait PartialInvariantFunctorSyntaxtrait InvariantFunctorSyntaxclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
trait LowLevelEndpoints
Members list
Type members
Inherited classlikes
Attributes
- Inherited from:
- Urls
- Supertypes
-
class Objecttrait Matchableclass Any
Value parameters
- entity
-
Contents of the callback message
- method
-
HTTP method used for the callback
- response
-
Expected response
Attributes
- Inherited from:
- EndpointsWithCustomErrors
- Supertypes
-
trait Serializableclass Objecttrait Matchableclass Any
Attributes
- Inherited from:
- EndpointsWithCustomErrors
- Supertypes
-
class Objecttrait Matchableclass Any
Concrete representation of an Endpoint
for routing purpose.
Concrete representation of an Endpoint
for routing purpose.
Attributes
- Inherited from:
- EndpointsWithCustomErrors
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Value parameters
- callbacks
-
Callbacks indexed by event name
- deprecated
-
Indicates whether this endpoint is deprecated or not
- description
-
Detailed description
- operationId
-
A unique identifier which identifies this operation
- summary
-
Short description
- tags
-
OpenAPI tags
Attributes
- Inherited from:
- EndpointsWithCustomErrors
- Supertypes
-
trait Serializableclass Objecttrait Matchableclass Any
Attributes
- Inherited from:
- EndpointsWithCustomErrors
- Supertypes
-
class Objecttrait Matchableclass Any
Extension methods for Endpoint.
Extension methods for Endpoint.
Attributes
- Inherited from:
- EndpointsWithCustomErrors
- Supertypes
-
class Objecttrait Matchableclass Any
An endpoint from which we can get a Play request handler.
An endpoint from which we can get a Play request handler.
Attributes
- Inherited from:
- EndpointsWithCustomErrors
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait ToPlayHandlerclass Objecttrait Matchableclass AnyShow all
Extension methods for values of type F[A]
for which there is an implicit InvariantFunctor[F]
instance.
Extension methods for values of type F[A]
for which there is an implicit InvariantFunctor[F]
instance.
Attributes
- Inherited from:
- InvariantFunctorSyntax
- Supertypes
-
class Objecttrait Matchableclass Any
HTTP Method
HTTP Method
Attributes
- Inherited from:
- Methods
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Inherited from:
- PartialInvariantFunctorSyntax
- Supertypes
-
class Objecttrait Matchableclass Any
An URL path carrying an A
information
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.
Attributes
- Note
-
This type has implicit methods provided by the PathOps, InvariantFunctorSyntax, and the PartialInvariantFunctorSyntax classes.
- Inherited from:
- Urls
- Supertypes
Convenient methods for Paths.
Convenient methods for Paths.
Attributes
- Inherited from:
- Urls
- Supertypes
-
class Objecttrait Matchableclass Any
Query string encoding and decoding
Query string encoding and decoding
Attributes
- Inherited from:
- Urls
- Supertypes
-
class Objecttrait Matchableclass Any
A query string parameter codec for type A
.
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
.
Attributes
- Note
-
This type has implicit methods provided by the PartialInvariantFunctorSyntax and the InvariantFunctorSyntax classes.
- Inherited from:
- Urls
- Supertypes
-
class Objecttrait Matchableclass Any
Extension methods on QueryString.
Extension methods on QueryString.
Attributes
- Inherited from:
- Urls
- Supertypes
-
class Objecttrait Matchableclass Any
An HTTP request.
An HTTP request.
Has an instance of InvariantFunctor
.
Attributes
- Inherited from:
- EndpointsWithCustomErrors
- Supertypes
-
class Objecttrait Matchableclass Any
Attributes
- Inherited from:
- Requests
- Supertypes
-
class Objecttrait Matchableclass Any
Extension methods for Request.
Extension methods for Request.
Attributes
- Inherited from:
- Requests
- Supertypes
-
class Objecttrait Matchableclass Any
Extension methods for Response.
Extension methods for Response.
Attributes
- Inherited from:
- Responses
- Supertypes
-
class Objecttrait Matchableclass Any
Defines how to decode and encode path segments
Defines how to decode and encode path segments
Attributes
- Inherited from:
- Urls
- Supertypes
-
class Objecttrait Matchableclass Any
Attributes
- Inherited from:
- SemigroupalSyntax
- Supertypes
-
class Objecttrait Matchableclass Any
Something that can be used as a Play request handler
Something that can be used as a Play request handler
Attributes
- Inherited from:
- EndpointsWithCustomErrors
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
An URL carrying an A
information
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.
Attributes
Inherited types
Callbacks indexed by URL pattern
Callbacks indexed by URL pattern
Attributes
- See also
-
Swagger Documentation at https://swagger.io/docs/specification/callbacks/
- Inherited from:
- EndpointsWithCustomErrors
Errors in a request built by a client
Errors in a request built by a client
Attributes
- Inherited from:
- BuiltInErrors
Decodes a request entity
Convenient type alias modeling the extraction of an A
information from request headers.
Convenient type alias modeling the extraction of an A
information from request headers.
This type has an instance of Applicative
.
Attributes
- Inherited from:
- Urls
An attempt to extract an A
from a request headers.
An attempt to extract an A
from a request headers.
Models failure by returning a Left(result)
. That makes it possible to early return an HTTP response if a header is wrong (e.g. if an authentication information is missing)
Attributes
- Inherited from:
- EndpointsWithCustomErrors
Turns the A
information into a proper Play Result
Turns the A
information into a proper Play Result
Attributes
- Inherited from:
- EndpointsWithCustomErrors
An HTTP response entity carrying an information of type A
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.
Attributes
- Note
-
This type has implicit methods provided by the InvariantFunctorSyntax class
- Inherited from:
- EndpointsWithCustomErrors
Information carried by responses’ headers.
Information carried by responses’ headers.
You can construct values of type ResponseHeaders
by using the operations responseHeader, optResponseHeader, or emptyResponseHeaders.
Attributes
- Note
-
This type has implicit methods provided by the SemigroupalSyntax and InvariantFunctorSyntax classes.
- Inherited from:
- EndpointsWithCustomErrors
Error raised by the business logic of a server
Error raised by the business logic of a server
Attributes
- Inherited from:
- BuiltInErrors
HTTP Status Code
This type is necessary to express different perspectives of servers and clients on optional query string parameters with default value:
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
Attributes
- Inherited from:
- Urls
Value members
Inherited methods
Attributes
- Inherited from:
- StatusCodes
Attributes
- Definition Classes
-
StatusCodes -> StatusCodes
- Inherited from:
- StatusCodes
Attributes
- Note
-
You should use the
badRequest
constructor provided by the endpoints4s.algebra.Responses trait to ensure that errors produced by endpoints4s are consistently handled by interpreters. - Inherited from:
- StatusCodes
Attributes
- Definition Classes
-
StatusCodes -> StatusCodes
- Inherited from:
- StatusCodes
Attributes
- Inherited from:
- StatusCodes
Attributes
- Definition Classes
-
StatusCodes -> StatusCodes
- Inherited from:
- StatusCodes
Attributes
- Definition Classes
-
StatusCodes -> StatusCodes
- Inherited from:
- StatusCodes
Attributes
- Inherited from:
- StatusCodes
Attributes
- Definition Classes
-
StatusCodes -> StatusCodes
- Inherited from:
- StatusCodes
Attributes
- Definition Classes
-
StatusCodes -> StatusCodes
- Inherited from:
- StatusCodes
Attributes
- Note
-
You should use the
internalServerError
constructor provided by the endpoints4s.algebra.Responses trait to ensure that errors produced by endpoints4s are consistently handled by interpreters. - Inherited from:
- StatusCodes
Attributes
- Definition Classes
-
StatusCodes -> StatusCodes
- Inherited from:
- StatusCodes
Attributes
- Definition Classes
-
StatusCodes -> StatusCodes
- Inherited from:
- StatusCodes
Attributes
- Definition Classes
-
StatusCodes -> StatusCodes
- Inherited from:
- StatusCodes
Attributes
- Definition Classes
-
StatusCodes -> StatusCodes
- Inherited from:
- StatusCodes
Attributes
- Definition Classes
-
StatusCodes -> StatusCodes
- Inherited from:
- StatusCodes
Attributes
- Inherited from:
- StatusCodes
Attributes
- Definition Classes
-
StatusCodes -> StatusCodes
- Inherited from:
- StatusCodes
Attributes
- Definition Classes
-
StatusCodes -> StatusCodes
- Inherited from:
- StatusCodes
Attributes
- Inherited from:
- StatusCodes
Attributes
- Inherited from:
- StatusCodes
Attributes
- Definition Classes
-
StatusCodes -> StatusCodes
- Inherited from:
- StatusCodes
Attributes
- Inherited from:
- StatusCodes
Attributes
- Definition Classes
-
StatusCodes -> StatusCodes
- Inherited from:
- StatusCodes
Attributes
- Inherited from:
- StatusCodes
Attributes
- Definition Classes
-
StatusCodes -> StatusCodes
- Inherited from:
- StatusCodes
Attributes
- Inherited from:
- StatusCodes
Attributes
- Definition Classes
-
StatusCodes -> StatusCodes
- Inherited from:
- StatusCodes
Attributes
- Definition Classes
-
StatusCodes -> StatusCodes
- Inherited from:
- StatusCodes
Attributes
- Definition Classes
-
StatusCodes -> StatusCodes
- Inherited from:
- StatusCodes
Attributes
- Definition Classes
-
StatusCodes -> StatusCodes
- Inherited from:
- StatusCodes
Attributes
- Definition Classes
-
StatusCodes -> StatusCodes
- Inherited from:
- StatusCodes
Attributes
- Definition Classes
-
StatusCodes -> StatusCodes
- Inherited from:
- StatusCodes
Attributes
- Definition Classes
-
StatusCodes -> StatusCodes
- Inherited from:
- StatusCodes
Attributes
- Inherited from:
- StatusCodes
Attributes
- Definition Classes
-
StatusCodes -> StatusCodes
- Inherited from:
- StatusCodes
Attributes
- Inherited from:
- StatusCodes
Attributes
- Inherited from:
- StatusCodes
Attributes
- Definition Classes
-
StatusCodes -> StatusCodes
- Inherited from:
- StatusCodes
Attributes
- Definition Classes
-
StatusCodes -> StatusCodes
- Inherited from:
- StatusCodes
Attributes
- Definition Classes
-
StatusCodes -> StatusCodes
- Inherited from:
- StatusCodes
Attributes
- Definition Classes
-
StatusCodes -> StatusCodes
- Inherited from:
- StatusCodes
Attributes
- Definition Classes
-
StatusCodes -> StatusCodes
- Inherited from:
- StatusCodes
Add the provided headers
to the request
.
Add the provided headers
to the request
.
Attributes
- Definition Classes
-
EndpointsWithCustomErrors -> Requests
- Inherited from:
- EndpointsWithCustomErrors
Add the provided queryString
to the request
.
Add the provided queryString
to the request
.
Attributes
- Definition Classes
-
EndpointsWithCustomErrors -> Requests
- Inherited from:
- EndpointsWithCustomErrors
Add the provided headers
to the response
.
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.
Attributes
- Definition Classes
-
EndpointsWithCustomErrors -> Responses
- Inherited from:
- EndpointsWithCustomErrors
Bad Request (400) response, with an entity of type ClientErrors
.
Bad Request (400) response, with an entity of type ClientErrors
.
Attributes
- See also
-
endpoints4s.algebra.Errors and endpoints4s.algebra.BuiltInErrors
- Inherited from:
- Responses
Chains the two paths
Alternative between two possible request entities, differentiated by the Content-Type
header
Alternative between two possible request entities, differentiated by the Content-Type
header
Attributes
- Note
-
If
A
andB
are both JSON-encoded and use disjoint schemas, use endpoints4s.algebra.JsonSchemas.TaggedOps#orElse at the schema level instead- Server interpreters accept either of the request entities
- Client interpreters provide one of the two request entities
- Documentation interpreters list all possible content types and their entities
- Inherited from:
- EndpointsWithCustomErrors
Alternative between two possible choices of responses.
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.
Attributes
- Inherited from:
- EndpointsWithCustomErrors
Response entity format for Invalid values
Convert the ClientErrors type into the endpoints4s internal client error type
Convert the ClientErrors type into the endpoints4s internal client error type
Attributes
- Inherited from:
- BuiltInErrors
Concatenates two QueryString
s
Helper method to perform DELETE request
Helper method to perform DELETE request
Type parameters
- HeadersP
-
Payload carried by headers
- UrlP
-
Payload carried by url
Attributes
- Inherited from:
- Requests
An empty response entity
No particular response header.
No particular response header.
- Client interpreters should ignore information carried by response headers.
Attributes
- Inherited from:
- EndpointsWithCustomErrors
Define an HTTP endpoint
Define an HTTP endpoint
Value parameters
- docs
-
Documentation (used by documentation interpreters)
- request
-
Request
- response
-
Response
Attributes
- Inherited from:
- EndpointsWithCustomErrors
Helper method to perform GET request
Helper method to perform GET request
Type parameters
- HeadersP
-
Payload carried by headers
- UrlP
-
Payload carried by url
Attributes
- Inherited from:
- Requests
This method is called by ''endpoints'' when decoding a request failed.
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.
Attributes
- Inherited from:
- Urls
This method is called by ''endpoints'' when an exception is thrown during request processing.
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.
Attributes
- Inherited from:
- EndpointsWithCustomErrors
Internal Server Error (500) response, with an entity of type ServerError
.
Internal Server Error (500) response, with an entity of type ServerError
.
Attributes
- See also
-
endpoints4s.algebra.Errors and endpoints4s.algebra.BuiltInErrors
- Inherited from:
- Responses
Convert the endpoints4s internal client error type into the ClientErrors type
Convert the endpoints4s internal client error type into the ClientErrors type
Attributes
- Inherited from:
- BuiltInErrors
Map the inner documentation of the endpoint to new documentation.
Map the inner documentation of the endpoint to new documentation.
Value parameters
- endpoint
-
The current endpoint that is being mapped.
- func
-
The function that maps the documentation to some new documentation.
Attributes
- Returns
-
The endpoint with the mapped documentation.
- Definition Classes
-
EndpointsWithCustomErrors -> EndpointsWithCustomErrors
- Inherited from:
- EndpointsWithCustomErrors
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 request of the endpoint to a new request. This is for example useful to add Auth headers to an existing endpoint.
Value parameters
- endpoint
-
The current endpoint that is being mapped.
- func
-
The function that maps the request to some new request.
Attributes
- Returns
-
The endpoint with the mapped request.
- Example
-
val myEndpoint: Endpoint[Input, Output] = ??? val basicAuthHeaders: RequestHeaders[Credentials] = ??? val endpointWithAuth: Endpoint[(Input, Credentials), Output] = myEndpoint.mapRequest(_.addHeaders(basicAuthHeader))
- Definition Classes
-
EndpointsWithCustomErrors -> EndpointsWithCustomErrors
- Inherited from:
- EndpointsWithCustomErrors
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.
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.
Value parameters
- endpoint
-
The current endpoint that is being mapped.
- func
-
The function that maps the response to some new response.
Attributes
- Returns
-
The endpoint with the mapped response.
- Example
-
val myEndpoint: Endpoint[Input, Output] = ??? val errorResponse: Response[Error] = ??? val endpointWithErrorHandling: Endpoint[Input, Either[Error, Output]] = myEndpoint.mapResponse(resp => resp orElse errorResponse)
- Definition Classes
-
EndpointsWithCustomErrors -> EndpointsWithCustomErrors
- Inherited from:
- EndpointsWithCustomErrors
OK (200) Response with the given entity
OK (200) Response with the given entity
Attributes
- Inherited from:
- Responses
Builds a QueryString
with one optional parameter, which has a default value.
Builds a QueryString
with one optional parameter, which has a default value.
Examples:
optQsWithDefault[Int]("page", 1) // optional `page` parameter, with default value 1
Type parameters
- A
-
Type of the value carried by the parameter
Value parameters
- name
-
Parameter’s name
Attributes
An optional request header
An optional request header
Value parameters
- name
-
Header name (e.g., “Authorization”)
Attributes
- Inherited from:
- EndpointsWithCustomErrors
Response headers optionally containing a header with the given name
.
Response headers optionally containing a header with the given name
.
- Client interpreters should model the header value as
Some[String]
, orNone
if the response header is missing. - Server interpreters should produce such a response header.
- Documentation interpreters should document this header.
Attributes
- Inherited from:
- EndpointsWithCustomErrors
Helper method to perform PATCH request
Helper method to perform PATCH request
Type parameters
- BodyP
-
Payload carried by body
- HeadersP
-
Payload carried by headers
- UrlAndBodyPTupled
-
Payloads of Url and Body tupled together by Tupler
- UrlP
-
Payload carried by url
Value parameters
- docs
-
Request documentation
Attributes
- Inherited from:
- Requests
Helper method to perform POST request
Helper method to perform POST request
Type parameters
- BodyP
-
Payload carried by body
- HeadersP
-
Payload carried by headers
- UrlAndBodyPTupled
-
Payloads of Url and Body tupled together by Tupler
- UrlP
-
Payload carried by url
Value parameters
- docs
-
Request documentation
Attributes
- Inherited from:
- Requests
Helper method to perform PUT request
Helper method to perform PUT request
Type parameters
- BodyP
-
Payload carried by body
- HeadersP
-
Payload carried by headers
- UrlAndBodyPTupled
-
Payloads of Url and Body tupled together by Tupler
- UrlP
-
Payload carried by url
Attributes
- Inherited from:
- Requests
Builds a QueryString
with one parameter.
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
Type parameters
- A
-
Type of the value carried by the parameter
Value parameters
- name
-
Parameter’s name
Attributes
- Inherited from:
- Urls
Value parameters
- args
-
Arguments to pass to the endpoint to generate its URL
- other
-
Endpoint to redirect to
Attributes
- Returns
-
An HTTP response redirecting to another endpoint (using 303 code status).
- Inherited from:
- EndpointsWithCustomErrors
The remaining segments of the path. The String
value carried by this Path
is still URL-encoded.
The remaining segments of the path. The String
value carried by this Path
is still URL-encoded.
Attributes
- Inherited from:
- Urls
Decodes a request.
Decodes a request.
Value parameters
- docs
-
Request documentation
- entity
-
Request entity
- headers
-
Request headers
- url
-
Request URL
Attributes
- Inherited from:
- EndpointsWithCustomErrors
A required request header
A required request header
Value parameters
- name
-
Header name (e.g., “Authorization”)
Attributes
- Inherited from:
- EndpointsWithCustomErrors
Define an HTTP response
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.
Value parameters
- docs
-
Response documentation
- entity
-
Response entity
- headers
-
Response headers
- statusCode
-
Response status code
Attributes
- Inherited from:
- EndpointsWithCustomErrors
Response headers containing a header with the given name
.
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")
)
)
Attributes
- Inherited from:
- EndpointsWithCustomErrors
Builds a Play router out of endpoint definitions.
Builds a Play router out of endpoint definitions.
val routes = routesFromEndpoints(
inc.implementedBy(x => x + 1)
)
Attributes
- Inherited from:
- EndpointsWithCustomErrors
A path segment carrying an A
information
Response entity format for Throwable
values
Convert the ServerError type into the endpoints4s internal server error type
Convert the ServerError type into the endpoints4s internal server error type
Attributes
- Inherited from:
- BuiltInErrors
A path segment whose value is the given segment
A text entity
Convert the endpoints4s internal server error type into the ServerError type
Convert the endpoints4s internal server error type into the ServerError type
Attributes
- Inherited from:
- BuiltInErrors
Builds an URL from the given path and query string
Turns a Response[A]
into a Response[Option[A]]
.
Turns a Response[A]
into a Response[Option[A]]
.
Interpreters represent None
with an empty HTTP response whose status code is 404 (Not Found).
Attributes
- Inherited from:
- Responses
Inherited fields
Response used by endpoints4s when decoding a request fails.
Response used by endpoints4s when decoding a request fails.
The provided implementation forwards to badRequest
.
Attributes
- Inherited from:
- Errors
Empty request -- request without a body. Use description
of endpoints4s.algebra.Endpoints#endpoint to document an empty body.
Empty request -- request without a body. Use description
of endpoints4s.algebra.Endpoints#endpoint to document an empty body.
Attributes
- Inherited from:
- EndpointsWithCustomErrors
Always succeeds in extracting no information from the headers
Always succeeds in extracting no information from the headers
Attributes
- Inherited from:
- EndpointsWithCustomErrors
A successful HTTP response (status code 200) with an HTML entity
A successful HTTP response (status code 200) with an HTML entity
Attributes
- Inherited from:
- EndpointsWithCustomErrors
An empty path.
An empty path.
Useful to begin a path definition:
path / "foo" / segment[Int] /? qs[String]("bar")
Attributes
- Inherited from:
- Urls
Attributes
- Inherited from:
- EndpointsWithCustomErrors
Response used by endpoints4s when the business logic of an endpoint fails.
Response used by endpoints4s when the business logic of an endpoint fails.
The provided implementation forwards to internalServerError
Attributes
- Inherited from:
- Errors
Request with a String
body.
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
Attributes
- Inherited from:
- EndpointsWithCustomErrors
Implicits
Inherited implicits
Attributes
- Inherited from:
- Urls
Attributes
- Inherited from:
- EndpointsWithCustomErrors
Extension methods for Endpoint.
Extension methods for Endpoint.
Attributes
- Inherited from:
- EndpointsWithCustomErrors
Extension methods for values of type F[A]
for which there is an implicit InvariantFunctor[F]
instance.
Extension methods for values of type F[A]
for which there is an implicit InvariantFunctor[F]
instance.
Attributes
- Inherited from:
- InvariantFunctorSyntax
Attributes
- Inherited from:
- PartialInvariantFunctorSyntax
Convenient methods for Paths.
Convenient methods for Paths.
Attributes
- Inherited from:
- Urls
Extension methods on QueryString.
Extension methods on QueryString.
Attributes
- Inherited from:
- Urls
Attributes
- Inherited from:
- Requests
Extension methods for Request.
Extension methods for Request.
Attributes
- Inherited from:
- Requests
Extension methods for Response.
Extension methods for Response.
Attributes
- Inherited from:
- Responses
Attributes
- Inherited from:
- SemigroupalSyntax
Attributes
- Inherited from:
- Urls
Query string parameter containing a Boolean
value
Query string parameter containing a Boolean
value
Attributes
- Inherited from:
- Urls
Codec for query string parameters of type Double
Codec for query string parameters of type Double
Attributes
- Inherited from:
- Urls
Path segment codec for type Double
Path segment codec for type Double
Attributes
- Inherited from:
- Urls
Attributes
- Inherited from:
- Urls
Ability to define Int
query string parameters
Ability to define Int
query string parameters
Attributes
- Inherited from:
- Urls
Path segment codec for type Int
Path segment codec for type Int
Attributes
- Inherited from:
- Urls
Attributes
- Inherited from:
- EndpointsWithCustomErrors
Query string parameter containing a Long
value
Query string parameter containing a Long
value
Attributes
- Inherited from:
- Urls
Path segment codec for type Long
Path segment codec for type Long
Attributes
- Inherited from:
- Urls
Make a query string parameter optional:
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.
Attributes
- Inherited from:
- Urls
Provides xmap
and xmapPartial
operations.
Provides xmap
and xmapPartial
operations.
Attributes
- See also
-
PartialInvariantFunctorSyntax and InvariantFunctorSyntax
- Inherited from:
- Urls
Provides xmap
and xmapPartial
operations.
Provides xmap
and xmapPartial
operations.
Attributes
- See also
-
PartialInvariantFunctorSyntax and InvariantFunctorSyntax
- Inherited from:
- Urls
Provides xmap
and xmapPartial
operations.
Provides xmap
and xmapPartial
operations.
Attributes
- See also
-
PartialInvariantFunctorSyntax and InvariantFunctorSyntax
- Inherited from:
- Urls
Support query string parameters with multiple values:
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.
Attributes
- Inherited from:
- Urls
Provides the operations xmap
and xmapPartial
.
Provides the operations xmap
and xmapPartial
.
Attributes
- See also
-
PartialInvariantFunctorSyntax
- Inherited from:
- EndpointsWithCustomErrors
Provides the operations xmap
and xmapPartial
.
Provides the operations xmap
and xmapPartial
.
Attributes
- See also
-
PartialInvariantFunctorSyntax
- Inherited from:
- EndpointsWithCustomErrors
Provides ++
operation.
Provides ++
operation.
Attributes
- See also
-
SemigroupalSyntax
- Inherited from:
- EndpointsWithCustomErrors
Provides the operations xmap
and xmapPartial
.
Provides the operations xmap
and xmapPartial
.
Attributes
- See also
-
PartialInvariantFunctorSyntax
- Inherited from:
- EndpointsWithCustomErrors
Attributes
- Inherited from:
- EndpointsWithCustomErrors
Provides xmap
operation.
Provides xmap
operation.
Attributes
- See also
-
InvariantFunctorSyntax
- Inherited from:
- EndpointsWithCustomErrors
Provides ++
operation.
Provides ++
operation.
Attributes
- See also
-
SemigroupalSyntax
- Inherited from:
- EndpointsWithCustomErrors
Provides the operation xmap
to the type Response
Provides the operation xmap
to the type Response
Attributes
- See also
-
InvariantFunctorSyntax
- Inherited from:
- EndpointsWithCustomErrors
Provides xmap
and xmapPartial
operations.
Provides xmap
and xmapPartial
operations.
Attributes
- See also
-
PartialInvariantFunctorSyntax and InvariantFunctorSyntax
- Inherited from:
- Urls
Ability to define String
query string parameters
Path segment codec for type String
Path segment codec for type String
- Server interpreters should return an URL-decoded string value,
- Client interpreters should take an URL-decoded string value.
Attributes
- Inherited from:
- Urls
Provides xmap
and xmapPartial
operations
Provides xmap
and xmapPartial
operations
Attributes
- See also
-
PartialInvariantFunctorSyntax and InvariantFunctorSyntax
- Inherited from:
- Urls
Ability to define UUID
query string parameters
Ability to define UUID
query string parameters
Attributes
- Inherited from:
- Urls
Path segment codec for type UUID
Path segment codec for type UUID
Attributes
- Inherited from:
- Urls