Packages

t

endpoints4s.http4s.server

EndpointsWithCustomErrors

trait EndpointsWithCustomErrors extends algebra.EndpointsWithCustomErrors with Methods with Urls

Interpreter for algebra.EndpointsWithCustomErrors based on http4s.

Source
Endpoints.scala
Type Hierarchy
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. EndpointsWithCustomErrors
  2. Urls
  3. StatusCodes
  4. Methods
  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 class RequestEntitySyntax[A] extends AnyRef
    Definition Classes
    Requests
  7. implicit class ResponseSyntax[A] extends AnyRef

    Extension methods for Response.

    Extension methods for Response.

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

    Convenient methods for Paths.

    Convenient methods for Paths.

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

    Extension methods on QueryString.

    Extension methods on QueryString.

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

  11. abstract type ClientErrors

    Errors in a request built by a client

    Errors in a request built by a client

    Definition Classes
    Errors
  12. abstract type Effect[A]
    Definition Classes
    EndpointsWithCustomErrorsUrls
  13. case class Endpoint[A, B](request: Request[A], response: Response[B], operationId: Option[String]) extends Product with Serializable
  14. type Method = org.http4s.Method

    HTTP Method

    HTTP Method

    Definition Classes
    MethodsMethods
  15. type Params = Map[String, Seq[String]]
    Definition Classes
    Urls
  16. type QueryString[A] = (Params) => Validated[A]

    A query string carrying an A information

    A query string carrying an A information

    QueryString values can be created with the qs operation, and can be combined with the & operation:

    val queryPageAndLang: QueryString[(Int, Option[String])] =
      qs[Int]("page") & qs[Option[String]]("lang")
    • Server interpreters raise an error if they can’t parse the incoming request query string parameters as a value of type A. By default, they produce a Bad Request (400) response with a list of error messages in a JSON array. Refer to the documentation of your server interpreter to customize this behavior.
    Definition Classes
    UrlsUrls
    Note

    This type has implicit methods provided by the QueryStringSyntax, InvariantFunctorSyntax, and the PartialInvariantFunctorSyntax classes.

  17. type Request[A] = PartialFunction[org.http4s.Request[Effect], Effect[Either[org.http4s.Response[Effect], A]]]

    Information carried by a whole request (headers and entity)

    Information carried by a whole request (headers and entity)

    Values of type Request[A] can be constructed by using the operations request, get, post, put, or delete.

    • Server interpreters raise an error if they can’t parse the incoming request as a value of type A. By default, they produce a Bad Request (400) response with a list of error messages in a JSON array. Refer to the documentation of your server interpreter to customize this behavior.
    Definition Classes
    EndpointsWithCustomErrorsRequests
    Note

    This type has implicit methods provided by the PartialInvariantFunctorSyntax class.

  18. type RequestEntity[A] = (org.http4s.Request[Effect]) => Effect[Either[org.http4s.Response[Effect], A]]

    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
    EndpointsWithCustomErrorsRequests
    Note

    This type has implicit methods provided by the PartialInvariantFunctorSyntax and RequestEntitySyntax classes.

  19. type RequestHeaders[A] = (Headers) => Validated[A]

    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
    EndpointsWithCustomErrorsRequests
    Note

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

  20. type Response[A] = (A) => org.http4s.Response[Effect]

    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
    EndpointsWithCustomErrorsResponses
    Note

    This type has implicit methods provided by the InvariantFunctorSyntax and ResponseSyntax classes

  21. type ResponseEntity[A] = EntityEncoder[Effect, 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

  22. type ResponseHeaders[A] = (A) => Headers

    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.

  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 = Status

    HTTP Status Code

    HTTP Status Code

    Definition Classes
    StatusCodesStatusCodes
  25. trait Path[A] extends EndpointsWithCustomErrors.Url[A]
    Definition Classes
    Urls
  26. trait QueryStringParam[A] extends AnyRef
    Definition Classes
    Urls
  27. trait Segment[A] extends AnyRef
    Definition Classes
    Urls
  28. trait Url[A] extends AnyRef
    Definition Classes
    Urls

Abstract Value Members

  1. implicit abstract def Effect: Sync[Effect]
  2. 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
  3. 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
  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 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: Status

    Definition Classes
    StatusCodesStatusCodes
  9. def AlreadyReported: Status

    Definition Classes
    StatusCodesStatusCodes
  10. def BadRequest: Status

    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: Status

    Definition Classes
    StatusCodesStatusCodes
  12. def Created: Status

    Definition Classes
    StatusCodesStatusCodes
  13. def Delete: Method

    Definition Classes
    MethodsMethods
  14. def ExpectationFailed: Status

    Definition Classes
    StatusCodesStatusCodes
  15. def FailedDependency: Status

    Definition Classes
    StatusCodesStatusCodes
  16. def Forbidden: Status

    Definition Classes
    StatusCodesStatusCodes
  17. def Get: Method

    Definition Classes
    MethodsMethods
  18. def Gone: Status

    Definition Classes
    StatusCodesStatusCodes
  19. def IMUsed: Status

    Definition Classes
    StatusCodesStatusCodes
  20. def InternalServerError: Status

    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: Status

    Definition Classes
    StatusCodesStatusCodes
  22. def Locked: Status

    Definition Classes
    StatusCodesStatusCodes
  23. def MethodNotAllowed: Status

    Definition Classes
    StatusCodesStatusCodes
  24. def MisdirectedRequest: Status

    Definition Classes
    StatusCodesStatusCodes
  25. def MultiStatus: Status

    Definition Classes
    StatusCodesStatusCodes
  26. def NoContent: Status

    Definition Classes
    StatusCodesStatusCodes
  27. def NonAuthoritativeInformation: Status

    Definition Classes
    StatusCodesStatusCodes
  28. def NotAcceptable: Status

    Definition Classes
    StatusCodesStatusCodes
  29. def NotFound: Status

    Definition Classes
    StatusCodesStatusCodes
  30. def NotImplemented: Status

    Definition Classes
    StatusCodesStatusCodes
  31. def NotModified: Status

    Definition Classes
    StatusCodesStatusCodes
  32. def OK: Status

    Definition Classes
    StatusCodesStatusCodes
  33. def Options: Method

    Definition Classes
    MethodsMethods
  34. def PartialContent: Status

    Definition Classes
    StatusCodesStatusCodes
  35. def Patch: Method

    Definition Classes
    MethodsMethods
  36. def PayloadTooLarge: Status

    Definition Classes
    StatusCodesStatusCodes
  37. def PaymentRequired: Status

    Definition Classes
    StatusCodesStatusCodes
  38. def Post: Method

    Definition Classes
    MethodsMethods
  39. def PreconditionFailed: Status

    Definition Classes
    StatusCodesStatusCodes
  40. def PreconditionRequired: Status

    Definition Classes
    StatusCodesStatusCodes
  41. def ProxyAuthenticationRequired: Status

    Definition Classes
    StatusCodesStatusCodes
  42. def Put: Method

    Definition Classes
    MethodsMethods
  43. def RangeNotSatisfiable: Status

    Definition Classes
    StatusCodesStatusCodes
  44. def RequestHeaderFieldsTooLarge: Status

    Definition Classes
    StatusCodesStatusCodes
  45. def RequestTimeout: Status

    Definition Classes
    StatusCodesStatusCodes
  46. def ResetContent: Status

    Definition Classes
    StatusCodesStatusCodes
  47. def TooEarly: Status

    Definition Classes
    StatusCodesStatusCodes
  48. def TooManyRequests: Status

    Definition Classes
    StatusCodesStatusCodes
  49. def Unauthorized: Status

    Definition Classes
    StatusCodesStatusCodes
  50. def UnavailableForLegalReasons: Status

    Definition Classes
    StatusCodesStatusCodes
  51. def UnprocessableEntity: Status

    Definition Classes
    StatusCodesStatusCodes
  52. def UnsupportedMediaType: Status

    Definition Classes
    StatusCodesStatusCodes
  53. def UpgradeRequired: Status

    Definition Classes
    StatusCodesStatusCodes
  54. def UriTooLong: Status

    Definition Classes
    StatusCodesStatusCodes
  55. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  56. 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

  57. implicit def booleanQueryString: QueryStringParam[Boolean]

    Query string parameter containing a Boolean value

    Query string parameter containing a Boolean value

    Definition Classes
    Urls
  58. 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
  59. 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
  60. 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
  61. 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
  62. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  63. 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
  64. 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
  65. implicit def doubleQueryString: QueryStringParam[Double]

    Codec for query string parameters of type Double

    Codec for query string parameters of type Double

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

    Path segment codec for type Double

    Path segment codec for type Double

    Definition Classes
    Urls
  67. def 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
  68. def emptyRequestHeaders: RequestHeaders[Unit]

    HEADERS

    HEADERS

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

    Empty response entity

    Empty response entity

    • Server interpreters produce no response entity,
    • Client interpreters ignore the response entity.
    Definition Classes
    EndpointsWithCustomErrorsResponses
  70. def emptyResponseHeaders: ResponseHeaders[Unit]

    No particular response header.

    No particular response header.

    • Client interpreters should ignore information carried by response headers.
    Definition Classes
    EndpointsWithCustomErrorsResponses
  71. 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
    EndpointsWithCustomErrorsEndpointsWithCustomErrors
  72. 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
  73. 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
  74. 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
  75. 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
  76. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  77. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  78. 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
    @inline()
  79. 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
  80. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  81. def handleClientErrors(invalid: Invalid): Effect[org.http4s.Response[Effect]]

    This method is called by endpoints when decoding a request failed.

    This method is called by endpoints when decoding a request failed.

    The provided implementation calls clientErrorsResponse to construct a response containing the errors.

    This method can be overridden to customize the error reporting logic.

  82. def handleServerError(throwable: Throwable): Effect[org.http4s.Response[Effect]]

    This method is called by endpoints when an exception is thrown during request processing.

    This method is called by endpoints when an exception is thrown during request processing.

    The provided implementation calls serverErrorResponse to construct a response containing the error message.

    This method can be overridden to customize the error reporting logic.

  83. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  84. implicit def intQueryString: QueryStringParam[Int]

    Ability to define Int query string parameters

    Ability to define Int query string parameters

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

    Path segment codec for type Int

    Path segment codec for type Int

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

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

    Query string parameter containing a Long value

    Query string parameter containing a Long value

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

    Path segment codec for type Long

    Path segment codec for type Long

    Definition Classes
    Urls
  90. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  91. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  92. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  93. 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
  94. 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
  95. 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
  96. 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
  97. 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
  98. 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
  99. implicit def pathPartialInvariantFunctor: PartialInvariantFunctor[Path]

    Provides xmap and xmapPartial operations.

    Provides xmap and xmapPartial operations.

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  100. 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
  101. 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
  102. def qs[A](name: String, docs: Documentation = None)(implicit value: 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
  103. implicit def queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]

    Provides xmap and xmapPartial operations.

    Provides xmap and xmapPartial operations.

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  104. implicit def queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]

    Provides xmap and xmapPartial operations.

    Provides xmap and xmapPartial operations.

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  105. def remainingSegments(name: String = "", docs: Documentation = None): 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
  106. 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
  107. def request[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](method: Method, url: Url[UrlP], entity: RequestEntity[BodyP] = emptyRequest, docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

    Request for given parameters

    Request for given parameters

    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

    method

    Request method

    url

    Request URL

    entity

    Request entity

    docs

    Request documentation

    headers

    Request headers

    Definition Classes
    EndpointsWithCustomErrorsRequests
  108. implicit def requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]

    Provides the operations xmap and xmapPartial.

    Provides the operations xmap and xmapPartial.

    Definition Classes
    EndpointsWithCustomErrorsRequests
    See also

    PartialInvariantFunctorSyntax

  109. 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
  110. implicit def requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]

    Provides the operations xmap and xmapPartial.

    Provides the operations xmap and xmapPartial.

    Definition Classes
    EndpointsWithCustomErrorsRequests
    See also

    PartialInvariantFunctorSyntax

  111. implicit def requestHeadersSemigroupal: Semigroupal[RequestHeaders]

    Provides ++ operation.

    Provides ++ operation.

    Definition Classes
    EndpointsWithCustomErrorsRequests
    See also

    SemigroupalSyntax

  112. implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]

    Provides the operations xmap and xmapPartial.

    Provides the operations xmap and xmapPartial.

    Definition Classes
    EndpointsWithCustomErrorsRequests
    See also

    PartialInvariantFunctorSyntax

  113. def response[A, B, R](statusCode: StatusCode, entity: ResponseEntity[A], docs: Documentation, headers: ResponseHeaders[B])(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
  114. implicit def responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
    Definition Classes
    EndpointsWithCustomErrorsResponses
  115. 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
  116. implicit def responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]

    Provides xmap operation.

    Provides xmap operation.

    Definition Classes
    EndpointsWithCustomErrorsResponses
    See also

    InvariantFunctorSyntax

  117. implicit def responseHeadersSemigroupal: Semigroupal[ResponseHeaders]

    Provides ++ operation.

    Provides ++ operation.

    Definition Classes
    EndpointsWithCustomErrorsResponses
    See also

    SemigroupalSyntax

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

  119. def routesFromEndpoints(endpoints: PartialFunction[org.http4s.Request[Effect], Effect[org.http4s.Response[Effect]]]*): PartialFunction[org.http4s.Request[Effect], Effect[org.http4s.Response[Effect]]]
  120. def segment[A](name: String = "", docs: Documentation = None)(implicit A: Segment[A]): Path[A]

    A path segment carrying an A information

    A path segment carrying an A information

    Definition Classes
    UrlsUrls
  121. implicit def segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]

    Provides xmap and xmapPartial operations.

    Provides xmap and xmapPartial operations.

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  122. 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
  123. 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
  124. implicit def stringQueryString: QueryStringParam[String]

    Ability to define String query string parameters

    Ability to define String query string parameters

    Definition Classes
    UrlsUrls
  125. implicit def 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
  126. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  127. def 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
  128. def textResponse: ResponseEntity[String]

    Text response entity

    Text response entity

    • Server interpreters produce an HTTP response with a text/plain content type.
    Definition Classes
    EndpointsWithCustomErrorsResponses
  129. def toString(): String
    Definition Classes
    AnyRef → Any
  130. implicit def urlPartialInvariantFunctor: PartialInvariantFunctor[Url]

    Provides xmap and xmapPartial operations

    Provides xmap and xmapPartial operations

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  131. 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
  132. val utf8Name: String
    Definition Classes
    Urls
  133. implicit def uuidQueryString: QueryStringParam[UUID]

    Ability to define UUID query string parameters

    Ability to define UUID query string parameters

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

    Path segment codec for type UUID

    Path segment codec for type UUID

    Definition Classes
    Urls
  135. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  136. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  137. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  138. 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 [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 Urls

Inherited from StatusCodes

Inherited from Methods

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