Packages

t

endpoints4s.xhr

EndpointsWithCustomErrors

trait EndpointsWithCustomErrors extends algebra.EndpointsWithCustomErrors with Urls with Methods with StatusCodes

Partial interpreter for algebra.Endpoints that builds a client issuing requests using XMLHttpRequest.

Source
Endpoints.scala
Type Hierarchy
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. EndpointsWithCustomErrors
  2. StatusCodes
  3. Methods
  4. Urls
  5. EndpointsWithCustomErrors
  6. Errors
  7. Responses
  8. StatusCodes
  9. Requests
  10. SemigroupalSyntax
  11. Methods
  12. Urls
  13. PartialInvariantFunctorSyntax
  14. InvariantFunctorSyntax
  15. AnyRef
  16. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef

    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.

    Definition Classes
    InvariantFunctorSyntax
  2. implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
  3. implicit class SemigroupalSyntax[A, F[_]] extends AnyRef
    Definition Classes
    SemigroupalSyntax
  4. final class CallbackDocs extends Serializable

    Definition Classes
    EndpointsWithCustomErrors
  5. final class EndpointDocs extends Serializable

    Definition Classes
    EndpointsWithCustomErrors
  6. implicit final class EndpointSyntax[A, B] extends AnyRef

    Extension methods for Endpoint.

    Extension methods for Endpoint.

    Definition Classes
    EndpointsWithCustomErrors
  7. implicit class RequestEntitySyntax[A] extends AnyRef
    Definition Classes
    Requests
  8. implicit final class RequestSyntax[A] extends AnyRef

    Extension methods for Request.

    Extension methods for Request.

    Definition Classes
    Requests
  9. implicit class ResponseSyntax[A] extends AnyRef

    Extension methods for Response.

    Extension methods for Response.

    Definition Classes
    Responses
  10. implicit class PathOps[A] extends AnyRef

    Convenient methods for Paths.

    Convenient methods for Paths.

    Definition Classes
    Urls
  11. implicit class QueryStringSyntax[A] extends AnyRef

    Extension methods on QueryString.

    Extension methods on QueryString.

    Definition Classes
    Urls
  12. 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/

  13. abstract type ClientErrors

    Errors in a request built by a client

    Errors in a request built by a client

    Definition Classes
    Errors
  14. abstract class Endpoint[A, B] extends (A) => Result[B]

    A function that takes the information needed to build a request and returns a task yielding the information carried by the response.

  15. type Method = String

    HTTP Method

    HTTP Method

    Definition Classes
    MethodsMethods
  16. trait Request[A] extends AnyRef

    A function that takes the information A and returns the data to create an XMLHttpRequest.

  17. type RequestEntity[A] = Function2[A, XMLHttpRequest, Any]

    A function that, given information A and an XMLHttpRequest, returns a request entity.

    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.

    Definition Classes
    EndpointsWithCustomErrorsRequests
  18. type RequestHeaders[A] = Function2[A, XMLHttpRequest, Unit]

    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.

    Definition Classes
    EndpointsWithCustomErrorsRequests
  19. type Response[A] = Function1[XMLHttpRequest, Option[ResponseEntity[A]]]

    Attempts to decode an A from an XMLHttpRequest’s response

    Attempts to decode an A from an XMLHttpRequest’s response

    Definition Classes
    EndpointsWithCustomErrorsResponses
  20. type ResponseEntity[A] = Function1[XMLHttpRequest, 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
    EndpointsWithCustomErrorsResponses
    Note

    This type has implicit methods provided by the InvariantFunctorSyntax class

  21. type ResponseHeaders[A] = (XMLHttpRequest) => 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
    EndpointsWithCustomErrorsResponses
    Note

    This type has implicit methods provided by the SemigroupalSyntax and InvariantFunctorSyntax classes.

  22. abstract type Result[A]

    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.

  23. abstract type ServerError

    Error raised by the business logic of a server

    Error raised by the business logic of a server

    Definition Classes
    Errors
  24. type StatusCode = Int

    HTTP Status Code

    HTTP Status Code

    Definition Classes
    StatusCodesStatusCodes
  25. 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
    Definition Classes
    UrlsUrls
  26. trait Path[A] extends Url[A]

    Builds an URL path from an A

    Builds an URL path from an A

    Definition Classes
    Urls
  27. 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
  28. 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
  29. 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
  30. trait Url[A] extends AnyRef

    Builds an URL from an A

    Builds an URL from an A

    Definition Classes
    Urls

Abstract Value Members

  1. 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
  2. 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
  3. 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
  4. 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
  5. 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
  6. 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
  7. abstract def settings: EndpointsSettings
  8. 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

  1. object CallbackDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  2. object EndpointDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  3. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def ##: Int
    Definition Classes
    AnyRef → Any
  5. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from EndpointsWithCustomErrors toany2stringadd[EndpointsWithCustomErrors] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  6. def ->[B](y: B): (EndpointsWithCustomErrors, B)
    Implicit
    This member is added by an implicit conversion from EndpointsWithCustomErrors toArrowAssoc[EndpointsWithCustomErrors] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  7. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def Accepted: Int

    Definition Classes
    StatusCodesStatusCodes
  9. def AlreadyReported: Int

    Definition Classes
    StatusCodesStatusCodes
  10. def BadRequest: Int

    Definition Classes
    StatusCodesStatusCodes
    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.

  11. def Conflict: Int

    Definition Classes
    StatusCodesStatusCodes
  12. def Created: Int

    Definition Classes
    StatusCodesStatusCodes
  13. def Delete: String

    Definition Classes
    MethodsMethods
  14. def ExpectationFailed: Int

    Definition Classes
    StatusCodesStatusCodes
  15. def FailedDependency: Int

    Definition Classes
    StatusCodesStatusCodes
  16. def Forbidden: Int

    Definition Classes
    StatusCodesStatusCodes
  17. def Get: String

    Definition Classes
    MethodsMethods
  18. def Gone: Int

    Definition Classes
    StatusCodesStatusCodes
  19. def IMUsed: Int

    Definition Classes
    StatusCodesStatusCodes
  20. def InternalServerError: Int

    Definition Classes
    StatusCodesStatusCodes
    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.

  21. def LengthRequired: Int

    Definition Classes
    StatusCodesStatusCodes
  22. def Locked: Int

    Definition Classes
    StatusCodesStatusCodes
  23. def MethodNotAllowed: Int

    Definition Classes
    StatusCodesStatusCodes
  24. def MisdirectedRequest: Int

    Definition Classes
    StatusCodesStatusCodes
  25. def MultiStatus: Int

    Definition Classes
    StatusCodesStatusCodes
  26. def NoContent: Int

    Definition Classes
    StatusCodesStatusCodes
  27. def NonAuthoritativeInformation: Int

    Definition Classes
    StatusCodesStatusCodes
  28. def NotAcceptable: Int

    Definition Classes
    StatusCodesStatusCodes
  29. def NotFound: Int

    Definition Classes
    StatusCodesStatusCodes
  30. def NotImplemented: Int

    Definition Classes
    StatusCodesStatusCodes
  31. def NotModified: Int

    Definition Classes
    StatusCodesStatusCodes
  32. def OK: Int

    Definition Classes
    StatusCodesStatusCodes
  33. def Options: String

    Definition Classes
    MethodsMethods
  34. def PartialContent: Int

    Definition Classes
    StatusCodesStatusCodes
  35. def Patch: String

    Definition Classes
    MethodsMethods
  36. def PayloadTooLarge: Int

    Definition Classes
    StatusCodesStatusCodes
  37. def PaymentRequired: Int

    Definition Classes
    StatusCodesStatusCodes
  38. def Post: String

    Definition Classes
    MethodsMethods
  39. def PreconditionFailed: Int

    Definition Classes
    StatusCodesStatusCodes
  40. def PreconditionRequired: Int

    Definition Classes
    StatusCodesStatusCodes
  41. def ProxyAuthenticationRequired: Int

    Definition Classes
    StatusCodesStatusCodes
  42. def Put: String

    Definition Classes
    MethodsMethods
  43. def RangeNotSatisfiable: Int

    Definition Classes
    StatusCodesStatusCodes
  44. def RequestHeaderFieldsTooLarge: Int

    Definition Classes
    StatusCodesStatusCodes
  45. def RequestTimeout: Int

    Definition Classes
    StatusCodesStatusCodes
  46. def ResetContent: Int

    Definition Classes
    StatusCodesStatusCodes
  47. def TooEarly: Int

    Definition Classes
    StatusCodesStatusCodes
  48. def TooManyRequests: Int

    Definition Classes
    StatusCodesStatusCodes
  49. def Unauthorized: Int

    Definition Classes
    StatusCodesStatusCodes
  50. def UnavailableForLegalReasons: Int

    Definition Classes
    StatusCodesStatusCodes
  51. def UnprocessableEntity: Int

    Definition Classes
    StatusCodesStatusCodes
  52. def UnsupportedMediaType: Int

    Definition Classes
    StatusCodesStatusCodes
  53. def UpgradeRequired: Int

    Definition Classes
    StatusCodesStatusCodes
  54. def UriTooLong: Int

    Definition Classes
    StatusCodesStatusCodes
  55. def addRequestHeaders[A, H](request: Request[A], headers: RequestHeaders[H])(implicit tupler: Tupler[A, H]): Request[Out]

    Add the provided headers to the request.

    Add the provided headers to the request.

    Definition Classes
    EndpointsWithCustomErrorsRequests
  56. def addRequestQueryString[A, Q](request: Request[A], qs: QueryString[Q])(implicit tupler: Tupler[A, Q]): Request[Out]

    Add the provided queryString to the request.

    Add the provided queryString to the request.

    Definition Classes
    EndpointsWithCustomErrorsRequests
  57. def addResponseHeaders[A, H](response: Response[A], headers: ResponseHeaders[H])(implicit tupler: Tupler[A, H]): Response[Out]

    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.

    Definition Classes
    EndpointsWithCustomErrorsResponses
  58. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  59. 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

  60. implicit def booleanQueryString: QueryStringParam[Boolean]

    Query string parameter containing a Boolean value

    Query string parameter containing a Boolean value

    Definition Classes
    Urls
  61. def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]

    Chains the two paths

    Chains the two paths

    Definition Classes
    UrlsUrls
  62. 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 header

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

    Definition Classes
    EndpointsWithCustomErrorsRequests
    Note

    If A and B 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
  63. 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
    EndpointsWithCustomErrorsResponses
  64. 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
  65. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  66. def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]

    Concatenates two QueryStrings

    Concatenates two QueryStrings

    Definition Classes
    UrlsUrls
  67. 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
  68. implicit def doubleQueryString: QueryStringParam[Double]

    Codec for query string parameters of type Double

    Codec for query string parameters of type Double

    Definition Classes
    Urls
  69. implicit def doubleSegment: Segment[Double]

    Path segment codec for type Double

    Path segment codec for type Double

    Definition Classes
    Urls
  70. 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
    EndpointsWithCustomErrorsRequests
  71. lazy val emptyRequestHeaders: RequestHeaders[Unit]

    Sets up no headers on the given XMLHttpRequest

    Sets up no headers on the given XMLHttpRequest

    Definition Classes
    EndpointsWithCustomErrorsRequests
  72. def emptyResponse: ResponseEntity[Unit]

    Discards response entity

    Discards response entity

    Definition Classes
    EndpointsWithCustomErrorsResponses
  73. def emptyResponseHeaders: ResponseHeaders[Unit]

    No particular response header.

    No particular response header.

    • Client interpreters should ignore information carried by response headers.
    Definition Classes
    EndpointsWithCustomErrorsResponses
  74. def ensuring(cond: (EndpointsWithCustomErrors) => Boolean, msg: => Any): EndpointsWithCustomErrors
    Implicit
    This member is added by an implicit conversion from EndpointsWithCustomErrors toEnsuring[EndpointsWithCustomErrors] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  75. def ensuring(cond: (EndpointsWithCustomErrors) => Boolean): EndpointsWithCustomErrors
    Implicit
    This member is added by an implicit conversion from EndpointsWithCustomErrors toEnsuring[EndpointsWithCustomErrors] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  76. def ensuring(cond: Boolean, msg: => Any): EndpointsWithCustomErrors
    Implicit
    This member is added by an implicit conversion from EndpointsWithCustomErrors toEnsuring[EndpointsWithCustomErrors] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  77. def ensuring(cond: Boolean): EndpointsWithCustomErrors
    Implicit
    This member is added by an implicit conversion from EndpointsWithCustomErrors toEnsuring[EndpointsWithCustomErrors] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  78. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  79. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  80. 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
  81. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  82. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  83. implicit def intQueryString: QueryStringParam[Int]

    Ability to define Int query string parameters

    Ability to define Int query string parameters

    Definition Classes
    Urls
  84. implicit def intSegment: Segment[Int]

    Path segment codec for type Int

    Path segment codec for type Int

    Definition Classes
    Urls
  85. 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

  86. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  87. implicit def longQueryString: QueryStringParam[Long]

    Query string parameter containing a Long value

    Query string parameter containing a Long value

    Definition Classes
    Urls
  88. implicit def longSegment: Segment[Long]

    Path segment codec for type Long

    Path segment codec for type Long

    Definition Classes
    Urls
  89. 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
    EndpointsWithCustomErrorsEndpointsWithCustomErrors
  90. 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
    EndpointsWithCustomErrorsEndpointsWithCustomErrors
    Example:
    1. val myEndpoint: Endpoint[Input, Output] = ???
      val basicAuthHeaders: RequestHeaders[Credentials] = ???
      
      val endpointWithAuth: Endpoint[(Input, Credentials), Output] =
        myEndpoint.mapRequest(_.addHeaders(basicAuthHeader))
  91. 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
    EndpointsWithCustomErrorsEndpointsWithCustomErrors
    Example:
    1. val myEndpoint: Endpoint[Input, Output] = ???
      val errorResponse: Response[Error] = ???
      
      val endpointWithErrorHandling: Endpoint[Input, Either[Error, Output]] =
        myEndpoint.mapResponse(resp => resp orElse errorResponse)
  92. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  93. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  94. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  95. 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
  96. 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.

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

    Examples:

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

    Type of the value carried by the parameter

    name

    Parameter’s name

    Definition Classes
    UrlsUrls
  97. 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
    EndpointsWithCustomErrorsRequests
  98. 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], or None if the response header is missing.
    • Server interpreters should produce such a response header.
    • Documentation interpreters should document this header.
    Definition Classes
    EndpointsWithCustomErrorsResponses
  99. 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.
    Definition Classes
    UrlsUrls
  100. 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

    Helper method to perform PATCH request

    UrlP

    Payload carried by url

    BodyP

    Payload carried by body

    HeadersP

    Payload carried by headers

    UrlAndBodyPTupled

    Payloads of Url and Body tupled together by Tupler

    docs

    Request documentation

    Definition Classes
    Requests
  101. 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
  102. implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]

    Provides xmap and xmapPartial operations.

    Provides xmap and xmapPartial operations.

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  103. final def performXhr[A, B](request: Request[A], response: Response[B], a: A)(onload: (Either[Throwable, B]) => Unit, onerror: (XMLHttpRequest) => Unit): Unit
    Attributes
    protected
  104. 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

    Helper method to perform POST request

    UrlP

    Payload carried by url

    BodyP

    Payload carried by body

    HeadersP

    Payload carried by headers

    UrlAndBodyPTupled

    Payloads of Url and Body tupled together by Tupler

    docs

    Request documentation

    Definition Classes
    Requests
  105. 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

    Helper method to perform PUT request

    UrlP

    Payload carried by url

    BodyP

    Payload carried by body

    HeadersP

    Payload carried by headers

    UrlAndBodyPTupled

    Payloads of Url and Body tupled together by Tupler

    Definition Classes
    Requests
  106. def qs[A](name: String, docs: Documentation)(implicit param: QueryStringParam[A]): QueryString[A]

    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
    A

    Type of the value carried by the parameter

    name

    Parameter’s name

    Definition Classes
    UrlsUrls
  107. implicit lazy val queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]

    Provides xmap and xmapPartial operations.

    Provides xmap and xmapPartial operations.

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  108. implicit lazy val queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]

    Provides xmap and xmapPartial operations.

    Provides xmap and xmapPartial operations.

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  109. def remainingSegments(name: String, docs: Documentation): Path[String]

    The remaining segments of the path.

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

    Definition Classes
    UrlsUrls
  110. 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.
    Definition Classes
    UrlsUrls
  111. 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
    EndpointsWithCustomErrorsRequests
  112. implicit lazy val requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]

    Provides the operations xmap and xmapPartial.

    Provides the operations xmap and xmapPartial.

    Definition Classes
    EndpointsWithCustomErrorsRequests
    See also

    PartialInvariantFunctorSyntax

  113. def requestHeader(name: String, docs: Documentation): RequestHeaders[String]

    A required request header

    A required request header

    name

    Header name (e.g., “Authorization”)

    Definition Classes
    EndpointsWithCustomErrorsRequests
  114. implicit lazy val requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]

    Provides the operations xmap and xmapPartial.

    Provides the operations xmap and xmapPartial.

    Definition Classes
    EndpointsWithCustomErrorsRequests
    See also

    PartialInvariantFunctorSyntax

  115. implicit lazy val requestHeadersSemigroupal: Semigroupal[RequestHeaders]

    Provides ++ operation.

    Provides ++ operation.

    Definition Classes
    EndpointsWithCustomErrorsRequests
    See also

    SemigroupalSyntax

  116. implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]

    Provides the operations xmap and xmapPartial.

    Provides the operations xmap and xmapPartial.

    Definition Classes
    EndpointsWithCustomErrorsRequests
    See also

    PartialInvariantFunctorSyntax

  117. 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
    EndpointsWithCustomErrorsResponses
  118. implicit def responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
    Definition Classes
    EndpointsWithCustomErrorsResponses
  119. 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
    EndpointsWithCustomErrorsResponses
  120. implicit def responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]

    Provides xmap operation.

    Provides xmap operation.

    Definition Classes
    EndpointsWithCustomErrorsResponses
    See also

    InvariantFunctorSyntax

  121. implicit def responseHeadersSemigroupal: Semigroupal[ResponseHeaders]

    Provides ++ operation.

    Provides ++ operation.

    Definition Classes
    EndpointsWithCustomErrorsResponses
    See also

    SemigroupalSyntax

  122. implicit lazy val responseInvariantFunctor: InvariantFunctor[Response]

    Provides the operation xmap to the type Response

    Provides the operation xmap to the type Response

    Definition Classes
    EndpointsWithCustomErrorsResponses
    See also

    InvariantFunctorSyntax

  123. def segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]

    A path segment carrying an A information

    A path segment carrying an A information

    Definition Classes
    UrlsUrls
  124. implicit lazy val segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]

    Provides xmap and xmapPartial operations.

    Provides xmap and xmapPartial operations.

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  125. 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
  126. def staticPathSegment(segment: String): Path[Unit]

    A path segment whose value is the given segment

    A path segment whose value is the given segment

    Definition Classes
    UrlsUrls
  127. def stringCodecResponse[A](implicit codec: Decoder[String, A]): ResponseEntity[A]
  128. implicit lazy val stringQueryString: QueryStringParam[String]

    Ability to define String query string parameters

    Ability to define String query string parameters

    Definition Classes
    UrlsUrls
  129. implicit lazy val stringSegment: Segment[String]

    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.
    Definition Classes
    UrlsUrls
  130. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  131. 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
    EndpointsWithCustomErrorsRequests
  132. def textResponse: ResponseEntity[String]

    Decodes a text entity

    Decodes a text entity

    Definition Classes
    EndpointsWithCustomErrorsResponses
  133. def toString(): String
    Definition Classes
    AnyRef → Any
  134. implicit lazy val urlPartialInvariantFunctor: PartialInvariantFunctor[Url]

    Provides xmap and xmapPartial operations

    Provides xmap and xmapPartial operations

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

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

    Builds an URL from the given path and query string

    Definition Classes
    UrlsUrls
  136. implicit def uuidQueryString: QueryStringParam[UUID]

    Ability to define UUID query string parameters

    Ability to define UUID query string parameters

    Definition Classes
    Urls
  137. implicit def uuidSegment: Segment[UUID]

    Path segment codec for type UUID

    Path segment codec for type UUID

    Definition Classes
    Urls
  138. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  139. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  140. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  141. final def wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation = None): Response[Option[A]]

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

    Definition Classes
    Responses

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from EndpointsWithCustomErrors toStringFormat[EndpointsWithCustomErrors] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def [B](y: B): (EndpointsWithCustomErrors, B)
    Implicit
    This member is added by an implicit conversion from EndpointsWithCustomErrors toArrowAssoc[EndpointsWithCustomErrors] 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 StatusCodes

Inherited from Methods

Inherited from Urls

Inherited from Errors

Inherited from Responses

Inherited from algebra.StatusCodes

Inherited from Requests

Inherited from algebra.Methods

Inherited from algebra.Urls

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromEndpointsWithCustomErrors to any2stringadd[EndpointsWithCustomErrors]

Inherited by implicit conversion StringFormat fromEndpointsWithCustomErrors to StringFormat[EndpointsWithCustomErrors]

Inherited by implicit conversion Ensuring fromEndpointsWithCustomErrors to Ensuring[EndpointsWithCustomErrors]

Inherited by implicit conversion ArrowAssoc fromEndpointsWithCustomErrors to ArrowAssoc[EndpointsWithCustomErrors]

Types

Types introduced by the algebra

Operations

Operations creating and transforming values

Ungrouped