Packages

trait Endpoints extends algebra.Endpoints with EndpointsWithCustomErrors with BuiltInErrors

Interpreter for algebra.Endpoints that performs routing using Akka-HTTP and uses algebra.BuiltInErrors to model client and server errors.

Source
Endpoints.scala
Type Hierarchy
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. Endpoints
  2. BuiltInErrors
  3. EndpointsWithCustomErrors
  4. Methods
  5. Urls
  6. StatusCodes
  7. Endpoints
  8. BuiltInErrors
  9. EndpointsWithCustomErrors
  10. Errors
  11. Responses
  12. StatusCodes
  13. Requests
  14. SemigroupalSyntax
  15. Methods
  16. Urls
  17. PartialInvariantFunctorSyntax
  18. InvariantFunctorSyntax
  19. AnyRef
  20. 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. 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/

  5. type ClientErrors = Invalid

    Errors in a request built by a client

    Errors in a request built by a client

    Definition Classes
    BuiltInErrorsErrors
  6. type Method = HttpMethod

    HTTP Method

    HTTP Method

    Definition Classes
    MethodsMethods
  7. type QueryStringParam[T] = (String, Map[String, Seq[String]]) => Validated[T]

    Given a parameter name and a query string content, returns a decoded parameter value of type T, or Invalid if decoding failed

    Given a parameter name and a query string content, returns a decoded parameter value of type T, or Invalid if decoding failed

    Definition Classes
    UrlsUrls
  8. type Request[A] = Directive[(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.

  9. type RequestEntity[A] = Directive[(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.

  10. type Response[A] = (A) => Route

    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

  11. type ResponseEntity[A] = Marshaller[A, MessageEntity]

    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

  12. type ResponseHeaders[A] = (A) => Seq[HttpHeader]

    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.

  13. type ServerError = Throwable

    Error raised by the business logic of a server

    Error raised by the business logic of a server

    Definition Classes
    BuiltInErrorsErrors
  14. type StatusCode = akka.http.scaladsl.model.StatusCode

    HTTP Status Code

    HTTP Status Code

    Definition Classes
    StatusCodesStatusCodes
  15. case class Endpoint[A, B](request: Request[A], response: Response[B]) extends Product with Serializable
    Definition Classes
    EndpointsWithCustomErrors
  16. trait RequestHeaders[A] extends AnyRef
    Definition Classes
    EndpointsWithCustomErrors
  17. trait Path[A] extends EndpointsWithCustomErrors.Url[A]
    Definition Classes
    Urls
  18. trait QueryString[T] extends AnyRef
    Definition Classes
    Urls
  19. trait Segment[A] extends AnyRef
    Definition Classes
    Urls
  20. trait Url[A] extends AnyRef
    Definition Classes
    Urls
  21. final class CallbackDocs extends Serializable

    Definition Classes
    EndpointsWithCustomErrors
  22. final class EndpointDocs extends Serializable

    Definition Classes
    EndpointsWithCustomErrors
  23. implicit class RequestEntitySyntax[A] extends AnyRef
    Definition Classes
    Requests
  24. implicit class ResponseSyntax[A] extends AnyRef

    Extension methods for Response.

    Extension methods for Response.

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

    Convenient methods for Paths.

    Convenient methods for Paths.

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

    Extension methods on QueryString.

    Extension methods on QueryString.

    Definition Classes
    Urls

Value Members

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

    Definition Classes
    StatusCodesStatusCodes
  7. def AlreadyReported: Success

    Definition Classes
    StatusCodesStatusCodes
  8. def BadRequest: ClientError

    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.

  9. def Conflict: ClientError

    Definition Classes
    StatusCodesStatusCodes
  10. def Created: Success

    Definition Classes
    StatusCodesStatusCodes
  11. def Delete: HttpMethod

    Definition Classes
    MethodsMethods
  12. def ExpectationFailed: ClientError

    Definition Classes
    StatusCodesStatusCodes
  13. def FailedDependency: ClientError

    Definition Classes
    StatusCodesStatusCodes
  14. def Forbidden: ClientError

    Definition Classes
    StatusCodesStatusCodes
  15. def Get: HttpMethod

    Definition Classes
    MethodsMethods
  16. def Gone: ClientError

    Definition Classes
    StatusCodesStatusCodes
  17. def IMUsed: Success

    Definition Classes
    StatusCodesStatusCodes
  18. def InternalServerError: akka.http.scaladsl.model.StatusCodes.ServerError

    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.

  19. def LengthRequired: ClientError

    Definition Classes
    StatusCodesStatusCodes
  20. def Locked: ClientError

    Definition Classes
    StatusCodesStatusCodes
  21. def MethodNotAllowed: ClientError

    Definition Classes
    StatusCodesStatusCodes
  22. def MisdirectedRequest: ClientError

    Definition Classes
    StatusCodesStatusCodes
  23. def MultiStatus: Success

    Definition Classes
    StatusCodesStatusCodes
  24. def NoContent: Success

    Definition Classes
    StatusCodesStatusCodes
  25. def NonAuthoritativeInformation: Success

    Definition Classes
    StatusCodesStatusCodes
  26. def NotAcceptable: ClientError

    Definition Classes
    StatusCodesStatusCodes
  27. def NotFound: ClientError

    Definition Classes
    StatusCodesStatusCodes
  28. def NotImplemented: akka.http.scaladsl.model.StatusCodes.ServerError

    Definition Classes
    StatusCodesStatusCodes
  29. def NotModified: Redirection

    Definition Classes
    StatusCodesStatusCodes
  30. def OK: Success

    Definition Classes
    StatusCodesStatusCodes
  31. def Options: HttpMethod

    Definition Classes
    MethodsMethods
  32. def PartialContent: Success

    Definition Classes
    StatusCodesStatusCodes
  33. def Patch: HttpMethod

    Definition Classes
    MethodsMethods
  34. def PayloadTooLarge: ClientError

    Definition Classes
    StatusCodesStatusCodes
  35. def PaymentRequired: ClientError

    Definition Classes
    StatusCodesStatusCodes
  36. def Post: HttpMethod

    Definition Classes
    MethodsMethods
  37. def PreconditionFailed: ClientError

    Definition Classes
    StatusCodesStatusCodes
  38. def PreconditionRequired: ClientError

    Definition Classes
    StatusCodesStatusCodes
  39. def ProxyAuthenticationRequired: ClientError

    Definition Classes
    StatusCodesStatusCodes
  40. def Put: HttpMethod

    Definition Classes
    MethodsMethods
  41. def RangeNotSatisfiable: ClientError

    Definition Classes
    StatusCodesStatusCodes
  42. def RequestHeaderFieldsTooLarge: ClientError

    Definition Classes
    StatusCodesStatusCodes
  43. def RequestTimeout: ClientError

    Definition Classes
    StatusCodesStatusCodes
  44. def ResetContent: Success

    Definition Classes
    StatusCodesStatusCodes
  45. def TooEarly: ClientError

    Definition Classes
    StatusCodesStatusCodes
  46. def TooManyRequests: ClientError

    Definition Classes
    StatusCodesStatusCodes
  47. def Unauthorized: ClientError

    Definition Classes
    StatusCodesStatusCodes
  48. def UnavailableForLegalReasons: ClientError

    Definition Classes
    StatusCodesStatusCodes
  49. def UnprocessableEntity: ClientError

    Definition Classes
    StatusCodesStatusCodes
  50. def UnsupportedMediaType: ClientError

    Definition Classes
    StatusCodesStatusCodes
  51. def UpgradeRequired: ClientError

    Definition Classes
    StatusCodesStatusCodes
  52. def UriTooLong: ClientError

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

  55. implicit def booleanQueryString: QueryStringParam[Boolean]

    Query string parameter containing a Boolean value

    Query string parameter containing a Boolean value

    Definition Classes
    Urls
  56. 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
  57. def choiceRequestEntity[A, B](requestEntityA: Directive1[A], requestEntityB: Directive1[B]): Directive1[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
  58. 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
  59. 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
  60. def clientErrorsResponseEntity: ResponseEntity[Invalid]

    Response entity format for Invalid values

    Response entity format for Invalid values

    Definition Classes
    BuiltInErrorsBuiltInErrorsErrors
  61. final 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
    BuiltInErrorsErrors
  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. def convToDirective1(directive: Directive0): Directive1[Unit]
    Attributes
    protected
    Definition Classes
    Urls
  65. 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
  66. lazy val directive1InvFunctor: PartialInvariantFunctor[Directive1]
    Definition Classes
    EndpointsWithCustomErrors
  67. implicit def doubleQueryString: QueryStringParam[Double]

    Codec for query string parameters of type Double

    Codec for query string parameters of type Double

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

    Path segment codec for type Double

    Path segment codec for type Double

    Definition Classes
    Urls
  69. 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
  70. def 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
    EndpointsWithCustomErrorsRequests
  71. 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
  72. def emptyResponseHeaders: ResponseHeaders[Unit]

    No particular response header.

    No particular response header.

    • Client interpreters should ignore information carried by response headers.
    Definition Classes
    EndpointsWithCustomErrorsResponses
  73. 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
  74. def ensuring(cond: (Endpoints) => Boolean, msg: => Any): Endpoints
    Implicit
    This member is added by an implicit conversion from Endpoints toEnsuring[Endpoints] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  75. def ensuring(cond: (Endpoints) => Boolean): Endpoints
    Implicit
    This member is added by an implicit conversion from Endpoints toEnsuring[Endpoints] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  76. def ensuring(cond: Boolean, msg: => Any): Endpoints
    Implicit
    This member is added by an implicit conversion from Endpoints toEnsuring[Endpoints] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  77. def ensuring(cond: Boolean): Endpoints
    Implicit
    This member is added by an implicit conversion from Endpoints toEnsuring[Endpoints] 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. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Endpoints toStringFormat[Endpoints] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  81. 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
  82. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  83. def handleClientErrors(invalid: Invalid): StandardRoute

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

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

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

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

    Definition Classes
    Urls
  84. def handleServerError(throwable: Throwable): StandardRoute

    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 uses serverErrorResponse to complete with a response containing the error message.

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

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

    Ability to define Int query string parameters

    Ability to define Int query string parameters

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

    Path segment codec for type Int

    Path segment codec for type Int

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

  89. final 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
    BuiltInErrorsErrors
  90. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  91. def joinDirectives[T1, T2](dir1: Directive1[T1], dir2: Directive1[T2])(implicit tupler: Tupler[T1, T2]): Directive1[Out]

    Simpler alternative to Directive.&() method

    Simpler alternative to Directive.&() method

    Attributes
    protected
    Definition Classes
    Urls
  92. implicit def longQueryString: QueryStringParam[Long]

    Query string parameter containing a Long value

    Query string parameter containing a Long value

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

    Path segment codec for type Long

    Path segment codec for type Long

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

    Provides xmap and xmapPartial operations.

    Provides xmap and xmapPartial operations.

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  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] = emptyRequest, docs: Documentation = None, headers: RequestHeaders[C] = emptyRequestHeaders)(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 lazy val 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 serverErrorResponseEntity: ResponseEntity[Throwable]

    Response entity format for Throwable values

    Response entity format for Throwable values

    Definition Classes
    BuiltInErrorsBuiltInErrorsErrors
  127. final 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
    BuiltInErrorsErrors
  128. 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
  129. implicit lazy val stringQueryString: QueryStringParam[String]

    Ability to define String query string parameters

    Ability to define String query string parameters

    Definition Classes
    UrlsUrls
  130. 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
  131. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  132. 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
  133. 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
  134. final 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
    BuiltInErrorsErrors
  135. def toString(): String
    Definition Classes
    AnyRef → Any
  136. implicit lazy val urlPartialInvariantFunctor: PartialInvariantFunctor[Url]

    Provides xmap and xmapPartial operations

    Provides xmap and xmapPartial operations

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  137. 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
  138. implicit def uuidQueryString: QueryStringParam[UUID]

    Ability to define UUID query string parameters

    Ability to define UUID query string parameters

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

    Path segment codec for type UUID

    Path segment codec for type UUID

    Definition Classes
    Urls
  140. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  141. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  142. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  143. 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
  144. object CallbackDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  145. object EndpointDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors

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): (Endpoints, B)
    Implicit
    This member is added by an implicit conversion from Endpoints toArrowAssoc[Endpoints] 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 BuiltInErrors

Inherited from Methods

Inherited from Urls

Inherited from StatusCodes

Inherited from algebra.Endpoints

Inherited from algebra.BuiltInErrors

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 fromEndpoints to any2stringadd[Endpoints]

Inherited by implicit conversion StringFormat fromEndpoints to StringFormat[Endpoints]

Inherited by implicit conversion Ensuring fromEndpoints to Ensuring[Endpoints]

Inherited by implicit conversion ArrowAssoc fromEndpoints to ArrowAssoc[Endpoints]

Types

Types introduced by the algebra

Operations

Operations creating and transforming values

Ungrouped