trait ChunkedJsonResponseEntities extends algebra.ChunkedJsonResponseEntities with ChunkedResponseEntities with JsonEntitiesFromCodecs with Framing
- Grouped
- Alphabetic
- By Inheritance
- ChunkedJsonResponseEntities
- Framing
- JsonEntitiesFromCodecs
- JsonEntitiesFromCodecs
- ChunkedResponseEntities
- Chunks
- EndpointsWithCustomErrors
- StatusCodes
- Methods
- Urls
- ChunkedJsonResponseEntities
- Framing
- JsonCodecs
- JsonEntities
- EndpointsWithCustomErrors
- Errors
- Responses
- StatusCodes
- Requests
- SemigroupalSyntax
- Methods
- Urls
- PartialInvariantFunctorSyntax
- InvariantFunctorSyntax
- ChunkedResponseEntities
- Chunks
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Type Members
- implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef
Extension methods for values of type
F[A]
for which there is an implicitInvariantFunctor[F]
instance.Extension methods for values of type
F[A]
for which there is an implicitInvariantFunctor[F]
instance.- Definition Classes
- InvariantFunctorSyntax
- implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
- Definition Classes
- PartialInvariantFunctorSyntax
- implicit class SemigroupalSyntax[A, F[_]] extends AnyRef
- Definition Classes
- SemigroupalSyntax
- final class CallbackDocs extends Serializable
- Definition Classes
- EndpointsWithCustomErrors
- final class EndpointDocs extends Serializable
- Definition Classes
- EndpointsWithCustomErrors
- implicit final class EndpointSyntax[A, B] extends AnyRef
Extension methods for Endpoint.
Extension methods for Endpoint.
- Definition Classes
- EndpointsWithCustomErrors
- implicit class RequestEntitySyntax[A] extends AnyRef
- Definition Classes
- Requests
- implicit final class RequestSyntax[A] extends AnyRef
Extension methods for Request.
- implicit class ResponseSyntax[A] extends AnyRef
Extension methods for Response.
- implicit class PathOps[A] extends AnyRef
Convenient methods for Paths.
- implicit class QueryStringSyntax[A] extends AnyRef
Extension methods on QueryString.
Extension methods on QueryString.
- Definition Classes
- Urls
- type CallbacksDocs = Map[String, CallbackDocs]
Callbacks indexed by URL pattern
Callbacks indexed by URL pattern
- Definition Classes
- EndpointsWithCustomErrors
- See also
Swagger Documentation at https://swagger.io/docs/specification/callbacks/
- type Chunks[A] = ReadableStream[A]
- Definition Classes
- Chunks
- abstract type ClientErrors
Errors in a request built by a client
Errors in a request built by a client
- Definition Classes
- Errors
- abstract type JsonCodec[A]
A JSON codec type class
A JSON codec type class
- Definition Classes
- JsonCodecs
- type JsonRequest[A] = JsonCodec[A]
Type class defining how to represent the
A
information as a JSON request entityType class defining how to represent the
A
information as a JSON request entity- Definition Classes
- JsonCodecs → JsonEntities
- type JsonResponse[A] = JsonCodec[A]
Type class defining how to represent the
A
information as a JSON response entityType class defining how to represent the
A
information as a JSON response entity- Definition Classes
- JsonCodecs → JsonEntities
- type Method = HttpMethod
HTTP Method
- type RequestEntity[A] = (A, RequestInit) => Unit
Information carried by request entity
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.
- Definition Classes
- EndpointsWithCustomErrors → Requests
- Note
This type has implicit methods provided by the PartialInvariantFunctorSyntax and RequestEntitySyntax classes.
- Server interpreters raise an error if they can’t parse the incoming
request entity as a value of type
- type RequestHeaders[A] = Function2[A, RequestInit, Unit]
Information carried by requests’ headers.
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.
- Definition Classes
- EndpointsWithCustomErrors → Requests
- Note
This type has implicit methods provided by the SemigroupalSyntax and PartialInvariantFunctorSyntax classes.
- Server interpreters raise an error if they can’t parse the incoming
request headers as a value of type
- type Response[A] = Function1[org.scalajs.dom.Response, Option[ResponseEntity[A]]]
An HTTP response (status, headers, and entity) carrying an information of type A
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.- Definition Classes
- EndpointsWithCustomErrors → Responses
- Note
This type has implicit methods provided by the InvariantFunctorSyntax and ResponseSyntax classes
- type ResponseEntity[A] = Function1[org.scalajs.dom.Response, Promise[Either[Throwable, A]]]
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.
- Definition Classes
- EndpointsWithCustomErrors → Responses
- Note
This type has implicit methods provided by the InvariantFunctorSyntax class
- type ResponseHeaders[A] = (org.scalajs.dom.Response) => Validated[A]
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.- Definition Classes
- EndpointsWithCustomErrors → Responses
- Note
This type has implicit methods provided by the SemigroupalSyntax and InvariantFunctorSyntax classes.
- abstract type Result[A]
- Definition Classes
- EndpointsWithCustomErrors
- abstract type ServerError
Error raised by the business logic of a server
Error raised by the business logic of a server
- Definition Classes
- Errors
- type StatusCode = Int
HTTP Status Code
HTTP Status Code
- Definition Classes
- StatusCodes → StatusCodes
- type WithDefault[A] = Option[A]
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
- Client interpreters should define it as
- abstract class Endpoint[A, B] extends (A) => Result[B]
- Definition Classes
- EndpointsWithCustomErrors
- trait Request[A] extends AnyRef
- Definition Classes
- EndpointsWithCustomErrors
- implicit class RequestInitOps extends AnyRef
- Definition Classes
- EndpointsWithCustomErrors
- class Framing extends AnyRef
- Definition Classes
- Framing
- trait Path[A] extends Url[A]
Builds an URL path from an
A
Builds an URL path from an
A
- Definition Classes
- Urls
- trait QueryString[A] extends AnyRef
Defines how to build a query string from an
A
Defines how to build a query string from an
A
- Definition Classes
- Urls
- trait QueryStringParam[A] extends AnyRef
Defines how to build a query string parameter value from an
A
Defines how to build a query string parameter value from an
A
- Definition Classes
- Urls
- trait Segment[A] extends AnyRef
Defines how to build a path segment from an
A
Defines how to build a path segment from an
A
- Definition Classes
- Urls
- trait Url[A] extends AnyRef
Builds an URL from an
A
Builds an URL from an
A
- Definition Classes
- Urls
Abstract Value Members
- abstract def clientErrorsResponseEntity: ResponseEntity[ClientErrors]
Format of the response entity carrying the client errors.
Format of the response entity carrying the client errors.
- Definition Classes
- Errors
- abstract def clientErrorsToInvalid(clientErrors: ClientErrors): Invalid
Convert the ClientErrors type into the endpoints4s internal client error type
Convert the ClientErrors type into the endpoints4s internal client error type
- Definition Classes
- Errors
- abstract def endpoint[A, B](request: Request[A], response: Response[B], docs: EndpointDocs = EndpointDocs()): Endpoint[A, B]
Define an HTTP endpoint
Define an HTTP endpoint
- request
Request
- response
Response
- docs
Documentation (used by documentation interpreters)
- Definition Classes
- EndpointsWithCustomErrors
- abstract def invalidToClientErrors(invalid: Invalid): ClientErrors
Convert the endpoints4s internal client error type into the ClientErrors type
Convert the endpoints4s internal client error type into the ClientErrors type
- Definition Classes
- Errors
- abstract def serverErrorResponseEntity: ResponseEntity[ServerError]
Format of the response entity carrying the server error.
Format of the response entity carrying the server error.
- Definition Classes
- Errors
- abstract def serverErrorToThrowable(serverError: ServerError): Throwable
Convert the ServerError type into the endpoints4s internal server error type
Convert the ServerError type into the endpoints4s internal server error type
- Definition Classes
- Errors
- abstract def settings: EndpointsSettings
- Definition Classes
- EndpointsWithCustomErrors
- abstract def stringCodec[A](implicit arg0: JsonCodec[A]): Codec[String, A]
Turns a JsonCodec[A] into a Codec[String, A]
Turns a JsonCodec[A] into a Codec[String, A]
- Definition Classes
- JsonEntitiesFromCodecs
- abstract def throwableToServerError(throwable: Throwable): ServerError
Convert the endpoints4s internal server error type into the ServerError type
Convert the endpoints4s internal server error type into the ServerError type
- Definition Classes
- Errors
Concrete Value Members
- object CallbackDocs extends Serializable
- Definition Classes
- EndpointsWithCustomErrors
- object EndpointDocs extends Serializable
- Definition Classes
- EndpointsWithCustomErrors
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from ChunkedJsonResponseEntities toany2stringadd[ChunkedJsonResponseEntities] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (ChunkedJsonResponseEntities, B)
- Implicit
- This member is added by an implicit conversion from ChunkedJsonResponseEntities toArrowAssoc[ChunkedJsonResponseEntities] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def Accepted: Int
- Definition Classes
- StatusCodes → StatusCodes
- def AlreadyReported: Int
- Definition Classes
- StatusCodes → StatusCodes
- def BadRequest: Int
- Definition Classes
- StatusCodes → StatusCodes
- 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.
- def Conflict: Int
- Definition Classes
- StatusCodes → StatusCodes
- def Created: Int
- Definition Classes
- StatusCodes → StatusCodes
- def Delete: Method
- def ExpectationFailed: Int
- Definition Classes
- StatusCodes → StatusCodes
- def FailedDependency: Int
- Definition Classes
- StatusCodes → StatusCodes
- def Forbidden: Int
- Definition Classes
- StatusCodes → StatusCodes
- def Get: Method
- def Gone: Int
- Definition Classes
- StatusCodes → StatusCodes
- def IMUsed: Int
- Definition Classes
- StatusCodes → StatusCodes
- def InternalServerError: Int
- Definition Classes
- StatusCodes → StatusCodes
- 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.
- def LengthRequired: Int
- Definition Classes
- StatusCodes → StatusCodes
- def Locked: Int
- Definition Classes
- StatusCodes → StatusCodes
- def MethodNotAllowed: Int
- Definition Classes
- StatusCodes → StatusCodes
- def MisdirectedRequest: Int
- Definition Classes
- StatusCodes → StatusCodes
- def MultiStatus: Int
- Definition Classes
- StatusCodes → StatusCodes
- def NoContent: Int
- Definition Classes
- StatusCodes → StatusCodes
- def NonAuthoritativeInformation: Int
- Definition Classes
- StatusCodes → StatusCodes
- def NotAcceptable: Int
- Definition Classes
- StatusCodes → StatusCodes
- def NotFound: Int
- Definition Classes
- StatusCodes → StatusCodes
- def NotImplemented: Int
- Definition Classes
- StatusCodes → StatusCodes
- def NotModified: Int
- Definition Classes
- StatusCodes → StatusCodes
- def OK: Int
- Definition Classes
- StatusCodes → StatusCodes
- def Options: Method
- def PartialContent: Int
- Definition Classes
- StatusCodes → StatusCodes
- def Patch: Method
- def PayloadTooLarge: Int
- Definition Classes
- StatusCodes → StatusCodes
- def PaymentRequired: Int
- Definition Classes
- StatusCodes → StatusCodes
- def PermanentRedirect: Int
- Definition Classes
- StatusCodes → StatusCodes
- def Post: Method
- def PreconditionFailed: Int
- Definition Classes
- StatusCodes → StatusCodes
- def PreconditionRequired: Int
- Definition Classes
- StatusCodes → StatusCodes
- def ProxyAuthenticationRequired: Int
- Definition Classes
- StatusCodes → StatusCodes
- def Put: Method
- def RangeNotSatisfiable: Int
- Definition Classes
- StatusCodes → StatusCodes
- def RequestHeaderFieldsTooLarge: Int
- Definition Classes
- StatusCodes → StatusCodes
- def RequestTimeout: Int
- Definition Classes
- StatusCodes → StatusCodes
- def ResetContent: Int
- Definition Classes
- StatusCodes → StatusCodes
- def TemporaryRedirect: Int
- Definition Classes
- StatusCodes → StatusCodes
- def TooEarly: Int
- Definition Classes
- StatusCodes → StatusCodes
- def TooManyRequests: Int
- Definition Classes
- StatusCodes → StatusCodes
- def Unauthorized: Int
- Definition Classes
- StatusCodes → StatusCodes
- def UnavailableForLegalReasons: Int
- Definition Classes
- StatusCodes → StatusCodes
- def UnprocessableEntity: Int
- Definition Classes
- StatusCodes → StatusCodes
- def UnsupportedMediaType: Int
- Definition Classes
- StatusCodes → StatusCodes
- def UpgradeRequired: Int
- Definition Classes
- StatusCodes → StatusCodes
- def UriTooLong: Int
- Definition Classes
- StatusCodes → StatusCodes
- def addRequestHeaders[A, H](request: Request[A], headers: RequestHeaders[H])(implicit tupler: Tupler[A, H]): Request[Out]
Add the provided
headers
to therequest
.Add the provided
headers
to therequest
.- Definition Classes
- EndpointsWithCustomErrors → Requests
- def addRequestQueryString[A, Q](request: Request[A], qs: QueryString[Q])(implicit tupler: Tupler[A, Q]): Request[Out]
Add the provided
queryString
to therequest
.Add the provided
queryString
to therequest
.- Definition Classes
- EndpointsWithCustomErrors → Requests
- def addResponseHeaders[A, H](response: Response[A], headers: ResponseHeaders[H])(implicit tupler: Tupler[A, H]): Response[Out]
Add the provided
headers
to theresponse
.Add the provided
headers
to theresponse
.Note that if the
response
describes a choice of several possible responses (resulting from theorElse
operation), theheaders
will be added to all the possible responses.- Definition Classes
- EndpointsWithCustomErrors → Responses
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- final def badRequest[A, R](docs: Documentation = None, headers: ResponseHeaders[A] = emptyResponseHeaders)(implicit tupler: Tupler.Aux[ClientErrors, A, R]): Response[R]
Bad Request (400) response, with an entity of type
ClientErrors
.Bad Request (400) response, with an entity of type
ClientErrors
.- Definition Classes
- Responses
- See also
endpoints4s.algebra.Errors and endpoints4s.algebra.BuiltInErrors
- implicit def booleanQueryString: QueryStringParam[Boolean]
Query string parameter containing a
Boolean
valueQuery string parameter containing a
Boolean
value- Definition Classes
- Urls
- def bytesChunksResponse: ResponseEntity[Chunks[Array[Byte]]]
A response entity carrying chunks of
Array[Byte]
valuesA response entity carrying chunks of
Array[Byte]
values- Definition Classes
- ChunkedResponseEntities → ChunkedResponseEntities
- def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
Chains the two paths
- def choiceRequestEntity[A, B](requestEntityA: RequestEntity[A], requestEntityB: RequestEntity[B]): RequestEntity[Either[A, B]]
Alternative between two possible request entities, differentiated by the
Content-Type
headerAlternative between two possible request entities, differentiated by the
Content-Type
header- Definition Classes
- EndpointsWithCustomErrors → Requests
- 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
- def choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]
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.
- Definition Classes
- EndpointsWithCustomErrors → Responses
- lazy val clientErrorsResponse: Response[ClientErrors]
Response used by endpoints4s when decoding a request fails.
Response used by endpoints4s when decoding a request fails.
The provided implementation forwards to
badRequest
.- Definition Classes
- Errors
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]
Concatenates two
QueryString
s - final def delete[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]
Helper method to perform DELETE request
Helper method to perform DELETE request
- UrlP
Payload carried by url
- HeadersP
Payload carried by headers
- Definition Classes
- Requests
- implicit def doubleQueryString: QueryStringParam[Double]
Codec for query string parameters of type
Double
Codec for query string parameters of type
Double
- Definition Classes
- Urls
- implicit def doubleSegment: Segment[Double]
Path segment codec for type
Double
Path segment codec for type
Double
- Definition Classes
- Urls
- lazy val emptyRequest: RequestEntity[Unit]
Empty request -- request without a body.
Empty request -- request without a body. Use
description
of endpoints4s.algebra.Endpoints#endpoint to document an empty body.- Definition Classes
- EndpointsWithCustomErrors → Requests
- lazy val emptyRequestHeaders: RequestHeaders[Unit]
Ignore headers
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.- Definition Classes
- EndpointsWithCustomErrors → Requests
- def emptyResponse: ResponseEntity[Unit]
Empty response entity
Empty response entity
- Server interpreters produce no response entity,
- Client interpreters ignore the response entity.
- Definition Classes
- EndpointsWithCustomErrors → Responses
- def emptyResponseHeaders: ResponseHeaders[Unit]
No particular response header.
No particular response header.
- Client interpreters should ignore information carried by response headers.
- Definition Classes
- EndpointsWithCustomErrors → Responses
- def ensuring(cond: (ChunkedJsonResponseEntities) => Boolean, msg: => Any): ChunkedJsonResponseEntities
- Implicit
- This member is added by an implicit conversion from ChunkedJsonResponseEntities toEnsuring[ChunkedJsonResponseEntities] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (ChunkedJsonResponseEntities) => Boolean): ChunkedJsonResponseEntities
- Implicit
- This member is added by an implicit conversion from ChunkedJsonResponseEntities toEnsuring[ChunkedJsonResponseEntities] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): ChunkedJsonResponseEntities
- Implicit
- This member is added by an implicit conversion from ChunkedJsonResponseEntities toEnsuring[ChunkedJsonResponseEntities] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): ChunkedJsonResponseEntities
- Implicit
- This member is added by an implicit conversion from ChunkedJsonResponseEntities toEnsuring[ChunkedJsonResponseEntities] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def get[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]
Helper method to perform GET request
Helper method to perform GET request
- UrlP
Payload carried by url
- HeadersP
Payload carried by headers
- Definition Classes
- Requests
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- implicit def intQueryString: QueryStringParam[Int]
Ability to define
Int
query string parametersAbility to define
Int
query string parameters- Definition Classes
- Urls
- implicit def intSegment: Segment[Int]
Path segment codec for type
Int
Path segment codec for type
Int
- Definition Classes
- Urls
- final def internalServerError[A, R](docs: Documentation = None, headers: ResponseHeaders[A] = emptyResponseHeaders)(implicit tupler: Tupler.Aux[ServerError, A, R]): Response[R]
Internal Server Error (500) response, with an entity of type
ServerError
.Internal Server Error (500) response, with an entity of type
ServerError
.- Definition Classes
- Responses
- See also
endpoints4s.algebra.Errors and endpoints4s.algebra.BuiltInErrors
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def jsonChunksResponse[A](framing: Framing)(implicit codec: JsonCodec[A]): ResponseEntity[Chunks[A]]
A response entity carrying chunks of JSON values
A response entity carrying chunks of JSON values
- A
Type of values serialized into JSON
- framing
Framing applied to chunks
- Definition Classes
- ChunkedJsonResponseEntities → ChunkedJsonResponseEntities
- def jsonChunksResponse[A](implicit codec: JsonCodec[A]): ResponseEntity[Chunks[A]]
- Definition Classes
- ChunkedJsonResponseEntities → ChunkedJsonResponseEntities
- def jsonRequest[A](implicit codec: JsonCodec[A]): (A, RequestInit) => Unit
Request with a JSON body, given an implicit
JsonRequest[A]
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
- Definition Classes
- JsonEntitiesFromCodecs → JsonEntities
- Server interpreters accept requests with content-type
- def jsonResponse[A](implicit codec: JsonCodec[A]): ResponseEntity[A]
Defines a
Response[A]
given an implicitJsonResponse[A]
Defines a
Response[A]
given an implicitJsonResponse[A]
- Definition Classes
- JsonEntitiesFromCodecs → JsonEntities
- implicit def longQueryString: QueryStringParam[Long]
Query string parameter containing a
Long
valueQuery string parameter containing a
Long
value- Definition Classes
- Urls
- implicit def longSegment: Segment[Long]
Path segment codec for type
Long
Path segment codec for type
Long
- Definition Classes
- Urls
- def mapEndpointDocs[A, B](endpoint: Endpoint[A, B], f: (EndpointDocs) => EndpointDocs): Endpoint[A, B]
Map the inner documentation of the endpoint to new documentation.
Map the inner documentation of the endpoint to new documentation.
- endpoint
The current endpoint that is being mapped.
- returns
The endpoint with the mapped documentation.
- Definition Classes
- EndpointsWithCustomErrors → EndpointsWithCustomErrors
- def mapEndpointRequest[A, B, C](endpoint: Endpoint[A, B], f: (Request[A]) => Request[C]): Endpoint[C, B]
Map the inner request of the endpoint to a new request.
Map the inner request of the endpoint to a new request. This is for example useful to add Auth headers to an existing endpoint.
- endpoint
The current endpoint that is being mapped.
- returns
The endpoint with the mapped request.
- Definition Classes
- EndpointsWithCustomErrors → EndpointsWithCustomErrors
val myEndpoint: Endpoint[Input, Output] = ??? val basicAuthHeaders: RequestHeaders[Credentials] = ??? val endpointWithAuth: Endpoint[(Input, Credentials), Output] = myEndpoint.mapRequest(_.addHeaders(basicAuthHeader))
Example: - def mapEndpointResponse[A, B, C](endpoint: Endpoint[A, B], f: (Response[B]) => Response[C]): Endpoint[A, C]
Map the inner response of the endpoint to a new response.
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.
- endpoint
The current endpoint that is being mapped.
- returns
The endpoint with the mapped response.
- Definition Classes
- EndpointsWithCustomErrors → EndpointsWithCustomErrors
val myEndpoint: Endpoint[Input, Output] = ??? val errorResponse: Response[Error] = ??? val endpointWithErrorHandling: Endpoint[Input, Either[Error, Output]] = myEndpoint.mapResponse(resp => resp orElse errorResponse)
Example: - final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- lazy val newLineDelimiterFraming: Framing
Frames are delimited by a new-line separator
- lazy val noopFraming: Framing
- Attributes
- protected
- Definition Classes
- Framing
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def ok[A, B, R](entity: ResponseEntity[A], docs: Documentation = None, headers: ResponseHeaders[B] = emptyResponseHeaders)(implicit tupler: Tupler.Aux[A, B, R]): Response[R]
OK (200) Response with the given entity
OK (200) Response with the given entity
- Definition Classes
- Responses
- def optQsWithDefault[A](name: String, default: A, docs: Documentation = None)(implicit value: QueryStringParam[A]): QueryString[WithDefault[A]]
Builds a
QueryString
with one optional parameter, which has a default value. - def optRequestHeader(name: String, docs: Documentation): RequestHeaders[Option[String]]
An optional request header
An optional request header
- name
Header name (e.g., “Authorization”)
- Definition Classes
- EndpointsWithCustomErrors → Requests
- def optResponseHeader(name: String, docs: Documentation = None): ResponseHeaders[Option[String]]
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.
- Definition Classes
- EndpointsWithCustomErrors → Responses
- Client interpreters should model the header value as
- implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]
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.
- final def patch[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
Helper method to perform PATCH request
- val path: Path[Unit]
An empty path.
An empty path.
Useful to begin a path definition:
path / "foo" / segment[Int] /? qs[String]("bar")
- Definition Classes
- Urls
- implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]
Provides
xmap
andxmapPartial
operations. - final def performFetch[A, B](request: Request[A], response: Response[B], a: A)(onload: (Either[Throwable, B]) => Unit, onerror: (Throwable) => Unit): Function0[Unit]
- Attributes
- protected
- Definition Classes
- EndpointsWithCustomErrors
- final def post[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
Helper method to perform POST request
- final def put[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
Helper method to perform PUT request
- def qs[A](name: String, docs: Documentation)(implicit param: QueryStringParam[A]): QueryString[A]
Builds a
QueryString
with one parameter. - implicit lazy val queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]
Provides
xmap
andxmapPartial
operations. - implicit lazy val queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]
Provides
xmap
andxmapPartial
operations. - def remainingSegments(name: String, docs: Documentation): Path[String]
The remaining segments of the path.
- implicit def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: QueryStringParam[A], factory: Factory[A, CC[A]]): QueryStringParam[CC[A]]
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.
- def request[A, B, C, AB, Out](method: Method, url: Url[A], entity: RequestEntity[B], docs: Documentation, headers: RequestHeaders[C])(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler.Aux[AB, C, Out]): Request[Out]
Request for given parameters
Request for given parameters
- method
Request method
- url
Request URL
- entity
Request entity
- docs
Request documentation
- headers
Request headers
- Definition Classes
- EndpointsWithCustomErrors → Requests
- implicit lazy val requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]
Provides the operations
xmap
andxmapPartial
.Provides the operations
xmap
andxmapPartial
.- Definition Classes
- EndpointsWithCustomErrors → Requests
- See also
- def requestHeader(name: String, docs: Documentation): RequestHeaders[String]
A required request header
A required request header
- name
Header name (e.g., “Authorization”)
- Definition Classes
- EndpointsWithCustomErrors → Requests
- implicit lazy val requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]
Provides the operations
xmap
andxmapPartial
.Provides the operations
xmap
andxmapPartial
.- Definition Classes
- EndpointsWithCustomErrors → Requests
- See also
- implicit lazy val requestHeadersSemigroupal: Semigroupal[RequestHeaders]
Provides
++
operation.Provides
++
operation.- Definition Classes
- EndpointsWithCustomErrors → Requests
- See also
- implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]
Provides the operations
xmap
andxmapPartial
.Provides the operations
xmap
andxmapPartial
.- Definition Classes
- EndpointsWithCustomErrors → Requests
- See also
- def response[A, B, R](statusCode: StatusCode, entity: ResponseEntity[A], docs: Documentation = None, headers: ResponseHeaders[B] = emptyResponseHeaders)(implicit tupler: Tupler.Aux[A, B, R]): Response[R]
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.
- statusCode
Response status code
- entity
Response entity
- docs
Response documentation
- headers
Response headers
- Definition Classes
- EndpointsWithCustomErrors → Responses
- implicit def responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
- Definition Classes
- EndpointsWithCustomErrors → Responses
- def responseHeader(name: String, docs: Documentation = None): ResponseHeaders[String]
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") ) )
- Definition Classes
- EndpointsWithCustomErrors → Responses
- Client interpreters should model the header value as
- implicit def responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]
Provides
xmap
operation.Provides
xmap
operation.- Definition Classes
- EndpointsWithCustomErrors → Responses
- See also
- implicit def responseHeadersSemigroupal: Semigroupal[ResponseHeaders]
Provides
++
operation.Provides
++
operation.- Definition Classes
- EndpointsWithCustomErrors → Responses
- See also
- implicit lazy val responseInvariantFunctor: InvariantFunctor[Response]
Provides the operation
xmap
to the typeResponse
Provides the operation
xmap
to the typeResponse
- Definition Classes
- EndpointsWithCustomErrors → Responses
- See also
- def segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]
A path segment carrying an
A
information - implicit lazy val segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]
Provides
xmap
andxmapPartial
operations. - lazy val serverErrorResponse: Response[ServerError]
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
- Definition Classes
- Errors
- def staticPathSegment(segment: String): Path[Unit]
A path segment whose value is the given
segment
- def stringCodecResponse[A](implicit codec: Decoder[String, A]): ResponseEntity[A]
- Definition Classes
- EndpointsWithCustomErrors
- implicit lazy val stringQueryString: QueryStringParam[String]
Ability to define
String
query string parameters - implicit lazy val stringSegment: Segment[String]
Path segment codec for type
String
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def textChunksResponse: ResponseEntity[Chunks[String]]
A response entity carrying chunks of
String
valuesA response entity carrying chunks of
String
values- Definition Classes
- ChunkedResponseEntities → ChunkedResponseEntities
- lazy val textRequest: RequestEntity[String]
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
- Definition Classes
- EndpointsWithCustomErrors → Requests
- Server interpreters accept requests with content-type
- def textResponse: ResponseEntity[String]
Text response entity
Text response entity
- Server interpreters produce an HTTP response with a
text/plain
content type.
- Definition Classes
- EndpointsWithCustomErrors → Responses
- Server interpreters produce an HTTP response with a
- def toString(): String
- Definition Classes
- AnyRef → Any
- implicit lazy val urlPartialInvariantFunctor: PartialInvariantFunctor[Url]
Provides
xmap
andxmapPartial
operations - def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]
Builds an URL from the given path and query string
- implicit def uuidQueryString: QueryStringParam[UUID]
Ability to define
UUID
query string parametersAbility to define
UUID
query string parameters- Definition Classes
- Urls
- implicit def uuidSegment: Segment[UUID]
Path segment codec for type
UUID
Path segment codec for type
UUID
- Definition Classes
- Urls
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation = None): Response[Option[A]]
Turns a
Response[A]
into aResponse[Option[A]]
.Turns a
Response[A]
into aResponse[Option[A]]
.Interpreters represent
None
with an empty HTTP response whose status code is 404 (Not Found).- Definition Classes
- Responses
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from ChunkedJsonResponseEntities toStringFormat[ChunkedJsonResponseEntities] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- def →[B](y: B): (ChunkedJsonResponseEntities, B)
- Implicit
- This member is added by an implicit conversion from ChunkedJsonResponseEntities toArrowAssoc[ChunkedJsonResponseEntities] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->
instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Inherited from fetch.Framing
Inherited from JsonEntitiesFromCodecs
Inherited from algebra.JsonEntitiesFromCodecs
Inherited from ChunkedResponseEntities
Inherited from fetch.Chunks
Inherited from EndpointsWithCustomErrors
Inherited from StatusCodes
Inherited from Methods
Inherited from Urls
Inherited from algebra.ChunkedJsonResponseEntities
Inherited from algebra.Framing
Inherited from JsonCodecs
Inherited from JsonEntities
Inherited from algebra.EndpointsWithCustomErrors
Inherited from Errors
Inherited from Responses
Inherited from algebra.StatusCodes
Inherited from Requests
Inherited from endpoints4s.SemigroupalSyntax
Inherited from algebra.Methods
Inherited from algebra.Urls
Inherited from endpoints4s.PartialInvariantFunctorSyntax
Inherited from endpoints4s.InvariantFunctorSyntax
Inherited from algebra.ChunkedResponseEntities
Inherited from algebra.Chunks
Inherited from AnyRef
Inherited from Any
Inherited by implicit conversion any2stringadd fromChunkedJsonResponseEntities to any2stringadd[ChunkedJsonResponseEntities]
Inherited by implicit conversion StringFormat fromChunkedJsonResponseEntities to StringFormat[ChunkedJsonResponseEntities]
Inherited by implicit conversion Ensuring fromChunkedJsonResponseEntities to Ensuring[ChunkedJsonResponseEntities]
Inherited by implicit conversion ArrowAssoc fromChunkedJsonResponseEntities to ArrowAssoc[ChunkedJsonResponseEntities]
Types
Types introduced by the algebra
Operations
Operations creating and transforming values