Packages

class Endpoints extends algebra.Endpoints with EndpointsWithCustomErrors with BuiltInErrors

Akka-HTTP based interpreter that 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. StatusCodes
  5. Methods
  6. Urls
  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 StringFormat
  2. by Ensuring
  3. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Endpoints(settings: EndpointsSettings)(implicit EC: ExecutionContext, M: Materializer)

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 Endpoint[A, B] = (A) => Future[B]

    Information carried by an HTTP endpoint

    Information carried by an HTTP endpoint

    Definition Classes
    EndpointsWithCustomErrorsEndpointsWithCustomErrors
  7. type Method = (HttpRequest) => HttpRequest

    HTTP Method

    HTTP Method

    Definition Classes
    MethodsMethods
  8. type QueryStringParam[A] = (A) => List[String]

    a query string parameter can have zero or several values

    a query string parameter can have zero or several values

    Definition Classes
    UrlsUrls
  9. type Request[A] = (A) => Future[HttpResponse]

    Information carried by a whole request (headers and entity)

    Information carried by a whole request (headers and entity)

    Definition Classes
    EndpointsWithCustomErrorsRequests
    Note

    This type has implicit methods provided by the PartialInvariantFunctorSyntax class.

  10. type RequestEntity[A] = (A, HttpRequest) => HttpRequest

    Information carried by request entity

    Information carried by request entity

    Definition Classes
    EndpointsWithCustomErrorsRequests
    Note

    This type has implicit methods provided by the PartialInvariantFunctorSyntax class.

  11. type RequestHeaders[A] = (A, List[HttpHeader]) => List[HttpHeader]

    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.

    Definition Classes
    EndpointsWithCustomErrorsRequests
    Note

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

  12. type Response[A] = (StatusCode, Seq[HttpHeader]) => Option[ResponseEntity[A]]

    An HTTP response (status, headers, and entity) carrying an information of type A

    An HTTP response (status, headers, and entity) carrying an information of type A

    Definition Classes
    EndpointsWithCustomErrorsResponses
    Note

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

  13. type ResponseEntity[A] = (HttpEntity) => Future[Either[Throwable, A]]

    An HTTP response entity carrying an information of type A

    An HTTP response entity carrying an information of type A

    Definition Classes
    EndpointsWithCustomErrorsResponses
    Note

    This type has implicit methods provided by the InvariantFunctorSyntax class

  14. type ResponseHeaders[A] = (Seq[HttpHeader]) => 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.

  15. type ServerError = Throwable

    Error raised by the business logic of a server

    Error raised by the business logic of a server

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

    HTTP Status Code

    HTTP Status Code

    Definition Classes
    StatusCodesStatusCodes
  17. case class InvalidHeaderDefinition(parsingResult: ParsingResult) extends RuntimeException with Product with Serializable
    Definition Classes
    EndpointsWithCustomErrors
  18. trait Path[A] extends Url[A]
    Definition Classes
    Urls
  19. trait QueryString[A] extends AnyRef
    Definition Classes
    Urls
  20. trait Segment[A] extends AnyRef
    Definition Classes
    Urls
  21. trait Url[A] extends AnyRef
    Definition Classes
    Urls
  22. case class CallbackDocs(method: EndpointsWithCustomErrors.Method, entity: EndpointsWithCustomErrors.RequestEntity[_], response: EndpointsWithCustomErrors.Response[_], requestDocs: Documentation = None) extends Product with Serializable

    method

    HTTP method used for the callback

    entity

    Contents of the callback message

    response

    Expected response

    Definition Classes
    EndpointsWithCustomErrors
  23. case class EndpointDocs(summary: Documentation = None, description: Documentation = None, tags: List[String] = Nil, callbacks: Map[String, CallbacksDocs] = Map.empty, deprecated: Boolean = false) extends Product with Serializable

    summary

    Short description

    description

    Detailed description

    tags

    OpenAPI tags

    callbacks

    Callbacks indexed by event name

    deprecated

    Indicates whether this endpoint is deprecated or not

    Definition Classes
    EndpointsWithCustomErrors
  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 ->[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()
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. def Accepted: Success

    Definition Classes
    StatusCodesStatusCodes
  6. def BadRequest: ClientError

    Definition Classes
    StatusCodesStatusCodes
    Note

    You should use the badRequest constructor provided by the endpoints.algebra.Responses trait to ensure that errors produced by endpoints are consistently handled by interpreters.

  7. def Created: Success

    Definition Classes
    StatusCodesStatusCodes
  8. def Delete: (HttpRequest) => HttpRequest

    Definition Classes
    MethodsMethods
  9. implicit val EC: ExecutionContext
    Definition Classes
    EndpointsEndpointsWithCustomErrors
  10. def Forbidden: ClientError

    Definition Classes
    StatusCodesStatusCodes
  11. def Get: (HttpRequest) => HttpRequest

    Definition Classes
    MethodsMethods
  12. def InternalServerError: akka.http.scaladsl.model.StatusCodes.ServerError

    Definition Classes
    StatusCodesStatusCodes
    Note

    You should use the internalServerError constructor provided by the endpoints.algebra.Responses trait to ensure that errors produced by endpoints are consistently handled by interpreters.

  13. implicit val M: Materializer
    Definition Classes
    EndpointsEndpointsWithCustomErrors
  14. def NoContent: Success

    Definition Classes
    StatusCodesStatusCodes
  15. def NotFound: ClientError

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

    Definition Classes
    StatusCodesStatusCodes
  17. def OK: Success

    Definition Classes
    StatusCodesStatusCodes
  18. def Options: (HttpRequest) => HttpRequest

    Definition Classes
    MethodsMethods
  19. def Patch: (HttpRequest) => HttpRequest

    Definition Classes
    MethodsMethods
  20. def Post: (HttpRequest) => HttpRequest

    Definition Classes
    MethodsMethods
  21. def Put: (HttpRequest) => HttpRequest

    Definition Classes
    MethodsMethods
  22. def Unauthorized: ClientError

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

    endpoints.algebra.Errors and endpoints.algebra.BuiltInErrors

  25. implicit def booleanQueryString: QueryStringParam[Boolean]

    Query string parameter containing a Boolean value

    Query string parameter containing a Boolean value

    Definition Classes
    Urls
  26. 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
  27. 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
  28. lazy val clientErrorsResponse: Response[ClientErrors]

    Response used by the endpoints library when decoding a request fails.

    Response used by the endpoints library when decoding a request fails.

    The provided implementation forwards to badRequest.

    Definition Classes
    Errors
  29. def clientErrorsResponseEntity: ResponseEntity[Invalid]

    Response entity format for Invalid values

    Response entity format for Invalid values

    Definition Classes
    BuiltInErrorsBuiltInErrorsErrors
  30. final def clientErrorsToInvalid(clientErrors: ClientErrors): Invalid

    Convert the ClientErrors type into the endpoints internal client error type

    Convert the ClientErrors type into the endpoints internal client error type

    Definition Classes
    BuiltInErrorsErrors
  31. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  32. 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
  33. def createHeader(name: String, value: String): HttpHeader
    Attributes
    protected
    Definition Classes
    EndpointsWithCustomErrors
  34. 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
  35. implicit def doubleQueryString: QueryStringParam[Double]

    Codec for query string parameters of type Double

    Codec for query string parameters of type Double

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

    Segment codec for type Double

    Segment codec for type Double

    Definition Classes
    Urls
  37. implicit def dummyPathToUrl[A](p: Path[A]): Url[A]

    Implicit conversion to get rid of intellij errors when defining paths.

    Implicit conversion to get rid of intellij errors when defining paths. Effectively should not be called.

    Definition Classes
    Urls
    See also

    https://youtrack.jetbrains.com/issue/SCL-16284

  38. lazy val emptyRequest: RequestEntity[Unit]

    Empty request -- request without a body.

    Empty request -- request without a body. Use description of endpoints.algebra.Endpoints#endpoint to document an empty body.

    Definition Classes
    EndpointsWithCustomErrorsRequests
  39. lazy val emptyRequestHeaders: RequestHeaders[Unit]

    No particular information.

    No particular information. Does not mean that the headers *have to* be empty. Just that, from a server point of view no information will be extracted from them, and from a client point of view no particular headers will be built in the request.

    Use description of endpoints.algebra.Endpoints#endpoint to document empty headers.

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

    Empty response entity

    Empty response entity

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

    No particular response header.

    No particular response header. Client interpreters should ignore information carried by response headers.

    Definition Classes
    EndpointsWithCustomErrorsResponses
  42. def endpoint[A, B](request: Request[A], response: Response[B], docs: EndpointDocs = EndpointDocs()): Endpoint[A, B]

    HTTP endpoint.

    HTTP endpoint.

    request

    Request

    response

    Response

    docs

    Documentation (used by documentation interpreters)

    Definition Classes
    EndpointsWithCustomErrorsEndpointsWithCustomErrors
  43. 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
  44. 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
  45. 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
  46. 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
  47. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  48. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  49. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  50. 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()
  51. 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
  52. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  53. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  54. implicit def intQueryString: QueryStringParam[Int]

    Ability to define Int query string parameters

    Ability to define Int query string parameters

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

    Ability to define Int path segments

    Ability to define Int path segments

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

    endpoints.algebra.Errors and endpoints.algebra.BuiltInErrors

  57. final def invalidToClientErrors(invalid: Invalid): ClientErrors

    Convert the endpoints internal client error type into the ClientErrors type

    Convert the endpoints internal client error type into the ClientErrors type

    Definition Classes
    BuiltInErrorsErrors
  58. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  59. implicit def longQueryString: QueryStringParam[Long]

    Query string parameter containing a Long value

    Query string parameter containing a Long value

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

    Segment containing a Long value

    Segment containing a Long value

    Definition Classes
    Urls
  61. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  62. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  63. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  64. 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
  65. def optRequestHeader(name: String, docs: Option[String]): (Option[String], List[HttpHeader]) => List[HttpHeader]

    An optional request header

    An optional request header

    name

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

    Definition Classes
    EndpointsWithCustomErrorsRequests
  66. 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
  67. 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. Server interpreters must report a failure for incoming requests whose optional query string parameters are present, but malformed.

    Definition Classes
    UrlsUrls
  68. 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
  69. implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]

    Provides xmap and xmapPartial operations.

    Provides xmap and xmapPartial operations.

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  70. 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
  71. 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
  72. 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
  73. implicit lazy val queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]

    Provides xmap and xmapPartial operations.

    Provides xmap and xmapPartial operations.

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  74. implicit lazy val queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]

    Provides xmap and xmapPartial operations.

    Provides xmap and xmapPartial operations.

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  75. 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
  76. 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
  77. 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
  78. implicit lazy val requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]

    Provides the operations xmap and xmapPartial.

    Provides the operations xmap and xmapPartial.

    Definition Classes
    EndpointsWithCustomErrorsRequests
    See also

    PartialInvariantFunctorSyntax

  79. def requestHeader(name: String, docs: Option[String]): (String, List[HttpHeader]) => List[HttpHeader]

    A required request header

    A required request header

    name

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

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

    Provides the operations xmap and xmapPartial.

    Provides the operations xmap and xmapPartial.

    Definition Classes
    EndpointsWithCustomErrorsRequests
    See also

    PartialInvariantFunctorSyntax

  81. implicit lazy val requestHeadersSemigroupal: Semigroupal[RequestHeaders]

    Provides ++ operation.

    Provides ++ operation.

    Definition Classes
    EndpointsWithCustomErrorsRequests
    See also

    SemigroupalSyntax

  82. implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]

    Provides the operations xmap and xmapPartial.

    Provides the operations xmap and xmapPartial.

    Definition Classes
    EndpointsWithCustomErrorsRequests
    See also

    PartialInvariantFunctorSyntax

  83. def response[A, B, R](statusCode: StatusCode, responseEntity: ResponseEntity[A], docs: Documentation = None, headers: ResponseHeaders[B] = emptyResponseHeaders)(implicit tupler: Tupler.Aux[A, B, R]): Response[R]

    Server interpreters construct a response with the given status and entity.

    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

    docs

    Response documentation

    headers

    Response headers

    Definition Classes
    EndpointsWithCustomErrorsResponses
  84. implicit def responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
    Definition Classes
    EndpointsWithCustomErrorsResponses
  85. 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
  86. implicit def responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]

    Provides xmap operation.

    Provides xmap operation.

    Definition Classes
    EndpointsWithCustomErrorsResponses
    See also

    InvariantFunctorSyntax

  87. implicit def responseHeadersSemigroupal: Semigroupal[ResponseHeaders]

    Provides ++ operation.

    Provides ++ operation.

    Definition Classes
    EndpointsWithCustomErrorsResponses
    See also

    SemigroupalSyntax

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

  89. 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
  90. implicit lazy val segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]

    Provides xmap and xmapPartial operations.

    Provides xmap and xmapPartial operations.

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  91. lazy val serverErrorResponse: Response[ServerError]

    Response used by the endpoints library when the business logic of an endpoint fails.

    Response used by the endpoints library when the business logic of an endpoint fails.

    The provided implementation forwards to internalServerError

    Definition Classes
    Errors
  92. def serverErrorResponseEntity: ResponseEntity[Throwable]

    Response entity format for Throwable values

    Response entity format for Throwable values

    Definition Classes
    BuiltInErrorsBuiltInErrorsErrors
  93. final def serverErrorToThrowable(serverError: ServerError): Throwable

    Convert the ServerError type into the endpoints internal server error type

    Convert the ServerError type into the endpoints internal server error type

    Definition Classes
    BuiltInErrorsErrors
  94. val settings: EndpointsSettings
    Definition Classes
    EndpointsEndpointsWithCustomErrors
  95. 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
  96. def stringCodecResponse[A](implicit codec: Decoder[String, A]): ResponseEntity[A]
    Definition Classes
    EndpointsWithCustomErrors
  97. implicit lazy val stringQueryString: QueryStringParam[String]

    Ability to define String query string parameters

    Ability to define String query string parameters

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

    Ability to define String path segments Servers should return an URL-decoded string value, and clients should take an URL-decoded string value.

    Ability to define String path segments Servers should return an URL-decoded string value, and clients should take an URL-decoded string value.

    Definition Classes
    UrlsUrls
  99. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  100. lazy val textRequest: (String, HttpRequest) => HttpRequest

    Request with a String body.

    Request with a String body.

    Definition Classes
    EndpointsWithCustomErrorsRequests
  101. def textResponse: ResponseEntity[String]

    Text response entity

    Text response entity

    Definition Classes
    EndpointsWithCustomErrorsResponses
  102. final def throwableToServerError(throwable: Throwable): ServerError

    Convert the endpoints internal server error type into the ServerError type

    Convert the endpoints internal server error type into the ServerError type

    Definition Classes
    BuiltInErrorsErrors
  103. def toString(): String
    Definition Classes
    AnyRef → Any
  104. def tryParseString[A](type: String)(parse: (String) => A): (String) => Validated[A]
    Definition Classes
    Urls
  105. implicit lazy val urlPartialInvariantFunctor: PartialInvariantFunctor[Url]

    Provides xmap and xmapPartial operations

    Provides xmap and xmapPartial operations

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  106. 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
  107. val utf8Name: String
    Definition Classes
    Urls
  108. implicit def uuidQueryString: QueryStringParam[UUID]

    Ability to define UUID query string parameters

    Ability to define UUID query string parameters

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

    Ability to define UUID path segments

    Ability to define UUID path segments

    Definition Classes
    Urls
  110. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  111. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  112. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  113. 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 [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 StatusCodes

Inherited from Methods

Inherited from Urls

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