JsonEntitiesFromCodecs
Interpreter for endpoints4s.algebra.JsonEntitiesFromCodecs that encodes JSON requests and decodes JSON responses.
Type members
Inherited classlikes
- Value parameters:
- entity
Contents of the callback message
- method
HTTP method used for the callback
- response
Expected response
- Inherited from:
- EndpointsWithCustomErrors
A function that takes the information needed to build a request and returns a task yielding the information carried by the response.
A function that takes the information needed to build a request and returns a task yielding the information carried by the response.
- Inherited from:
- EndpointsWithCustomErrors
- 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
- Inherited from:
- EndpointsWithCustomErrors
Extension methods for Endpoint.
Extension methods for Endpoint.
- 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.
- Inherited from:
- InvariantFunctorSyntax
- Inherited from:
- PartialInvariantFunctorSyntax
Defines how to build a query string from an A
Defines how to build a query string from an A
- Inherited from:
- Urls
Defines how to build a query string parameter value from an A
Defines how to build a query string parameter value from an A
- Inherited from:
- Urls
A function that takes the information A
and returns the data to create
an XMLHttpRequest.
A function that takes the information A
and returns the data to create
an XMLHttpRequest.
- Inherited from:
- EndpointsWithCustomErrors
Defines how to build a path segment from an A
Defines how to build a path segment from an A
- Inherited from:
- Urls
Inherited types
Callbacks indexed by URL pattern
Callbacks indexed by URL pattern
- 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
- Inherited from:
- Errors
A function that, given information A
and an XMLHttpRequest, returns
a request entity.
Also, as a side-effect, the function can set the corresponding Content-Type header
on the given XMLHttpRequest.
A function that, given information A
and an XMLHttpRequest, returns
a request entity.
Also, as a side-effect, the function can set the corresponding Content-Type header
on the given XMLHttpRequest.
- Inherited from:
- EndpointsWithCustomErrors
A function that takes the information A
and the XMLHttpRequest
and sets up some headers on it.
A function that takes the information A
and the XMLHttpRequest
and sets up some headers on it.
- Inherited from:
- EndpointsWithCustomErrors
Attempts to decode an A
from an XMLHttpRequest’s response
Attempts to decode an A
from an XMLHttpRequest’s response
- Inherited from:
- EndpointsWithCustomErrors
A value that eventually yields an A
.
A value that eventually yields an A
.
Typically, concrete representation of Result
will have an instance of MonadError
, so
that we can perform requests (sequentially and in parallel) and recover errors.
- Inherited from:
- EndpointsWithCustomErrors
Error raised by the business logic of a server
Error raised by the business logic of a server
- Inherited from:
- Errors
Value members
Concrete methods
Inherited methods
- Definition Classes
- Inherited from:
- EndpointsWithCustomErrors
- Definition Classes
- Inherited from:
- EndpointsWithCustomErrors
- Definition Classes
- Inherited from:
- EndpointsWithCustomErrors
Bad Request (400) response, with an entity of type ClientErrors
.
Bad Request (400) response, with an entity of type ClientErrors
.
- See also:
- Inherited from:
- Responses
- Inherited from:
- EndpointsWithCustomErrors
Format of the response entity carrying the client errors.
Format of the response entity carrying the client errors.
- Inherited from:
- Errors
Convert the ClientErrors type into the endpoints4s internal client error type
Convert the ClientErrors type into the endpoints4s internal client error type
- Inherited from:
- Errors
- Inherited from:
- Urls
Helper method to perform DELETE request
Helper method to perform DELETE request
- Type parameters:
- HeadersP
Payload carried by headers
- UrlP
Payload carried by url
- Inherited from:
- Requests
Define an HTTP endpoint
Define an HTTP endpoint
- Value parameters:
- docs
Documentation (used by documentation interpreters)
- request
Request
- response
Response
- 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
- Inherited from:
- Requests
Internal Server Error (500) response, with an entity of type ServerError
.
Internal Server Error (500) response, with an entity of type ServerError
.
- See also:
- 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
- Inherited from:
- Errors
- Definition Classes
- Inherited from:
- EndpointsWithCustomErrors
- Definition Classes
- Inherited from:
- EndpointsWithCustomErrors
- Definition Classes
- Inherited from:
- EndpointsWithCustomErrors
OK (200) Response with the given entity
OK (200) Response with the given entity
- Inherited from:
- Responses
Helper method to perform PATCH request
Helper method to perform POST request
- Inherited from:
- EndpointsWithCustomErrors
- Inherited from:
- EndpointsWithCustomErrors
Format of the response entity carrying the server error.
Format of the response entity carrying the server error.
- Inherited from:
- Errors
Convert the ServerError type into the endpoints4s internal server error type
Convert the ServerError type into the endpoints4s internal server error type
- Inherited from:
- Errors
Turns a JsonCodec[A] into a Codec[String, A]
Turns a JsonCodec[A] into a Codec[String, A]
- Inherited from:
- JsonEntitiesFromCodecs
Convert the endpoints4s internal server error type into the ServerError type
Convert the endpoints4s internal server error type into the ServerError type
- Inherited from:
- Errors
- Inherited from:
- Urls
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).
- 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
.
- Inherited from:
- Errors
Sets up no headers on the given XMLHttpRequest
Sets up no headers on the given XMLHttpRequest
- Inherited from:
- EndpointsWithCustomErrors
An empty path.
An empty path.
Useful to begin a path definition:
path / "foo" / segment[Int] /? qs[String]("bar")
- Inherited from:
- Urls
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
- Inherited from:
- Errors
Implicits
Inherited implicits
Extension methods for Endpoint.
Extension methods for Endpoint.
- 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.
- Inherited from:
- InvariantFunctorSyntax
- Inherited from:
- PartialInvariantFunctorSyntax
- Inherited from:
- SemigroupalSyntax
Query string parameter containing a Boolean
value
Query string parameter containing a Boolean
value
- Inherited from:
- Urls
Codec for query string parameters of type Double
Codec for query string parameters of type Double
- Inherited from:
- Urls
Ability to define Int
query string parameters
Ability to define Int
query string parameters
- Inherited from:
- Urls
Query string parameter containing a Long
value
Query string parameter containing a Long
value
- Inherited from:
- Urls
- Inherited from:
- Urls
- Inherited from:
- Urls
- Inherited from:
- Urls
Ability to define UUID
query string parameters
Ability to define UUID
query string parameters
- Inherited from:
- Urls