Packages

t

endpoints4s.fetch

JsonEntitiesFromCodecs

trait JsonEntitiesFromCodecs extends EndpointsWithCustomErrors with algebra.JsonEntitiesFromCodecs

Source
JsonEntities.scala
Type Hierarchy
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. JsonEntitiesFromCodecs
  2. JsonEntitiesFromCodecs
  3. JsonCodecs
  4. JsonEntities
  5. EndpointsWithCustomErrors
  6. StatusCodes
  7. Methods
  8. Urls
  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

Types

Types introduced by the algebra

  1. abstract type ClientErrors

    Errors in a request built by a client

    Errors in a request built by a client

    Definition Classes
    Errors
  2. abstract type JsonCodec[A]

    A JSON codec type class

    A JSON codec type class

    Definition Classes
    JsonCodecs
  3. type JsonRequest[A] = JsonCodec[A]

    Type class defining how to represent the A information as a JSON request entity

    Type class defining how to represent the A information as a JSON request entity

    Definition Classes
    JsonCodecsJsonEntities
  4. type JsonResponse[A] = JsonCodec[A]

    Type class defining how to represent the A information as a JSON response entity

    Type class defining how to represent the A information as a JSON response entity

    Definition Classes
    JsonCodecsJsonEntities
  5. type Method = HttpMethod

    HTTP Method

    HTTP Method

    Definition Classes
    MethodsMethods
  6. type RequestEntity[A] = (A, RequestInit) => Unit

    Information carried by request entity

    Information carried by request entity

    Values of type RequestEntity[A] can be constructed by using the operations emptyRequest or textRequest. Additional types of request entities are provided by other algebra modules, such as JsonEntities or ChunkedEntities.

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

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

  7. type RequestHeaders[A] = Function2[A, RequestInit, Unit]

    Information carried by requests’ headers.

    Information carried by requests’ headers.

    You can construct values of type RequestHeaders by using the operations requestHeader, optRequestHeader, or emptyRequestHeaders.

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

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

  8. type Response[A] = Function1[org.scalajs.dom.Response, Option[ResponseEntity[A]]]

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

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

    Values of type Response[A] can be constructed by using the operations ok, badRequest, internalServerError, or the more general operation response.

    Definition Classes
    EndpointsWithCustomErrorsResponses
    Note

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

  9. type ResponseEntity[A] = Function1[org.scalajs.dom.Response, Promise[Either[Throwable, A]]]

    An HTTP response entity carrying an information of type A

    An HTTP response entity carrying an information of type A

    Values of type ResponseEntity can be constructed by using the operations emptyResponse or textResponse. Additional types of response entities are provided by other algebra modules, such as JsonEntities or ChunkedEntities.

    Definition Classes
    EndpointsWithCustomErrorsResponses
    Note

    This type has implicit methods provided by the InvariantFunctorSyntax class

  10. type ResponseHeaders[A] = (org.scalajs.dom.Response) => Validated[A]

    Information carried by responses’ headers.

    Information carried by responses’ headers.

    You can construct values of type ResponseHeaders by using the operations responseHeader, optResponseHeader, or emptyResponseHeaders.

    Definition Classes
    EndpointsWithCustomErrorsResponses
    Note

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

  11. abstract type ServerError

    Error raised by the business logic of a server

    Error raised by the business logic of a server

    Definition Classes
    Errors
  12. type StatusCode = Int

    HTTP Status Code

    HTTP Status Code

    Definition Classes
    StatusCodesStatusCodes
  13. type WithDefault[A] = Option[A]

    This type is necessary to express different perspectives of servers and clients on optional query string parameters with default value:

    This type is necessary to express different perspectives of servers and clients on optional query string parameters with default value:

    • Client interpreters should define it as Option[A] and omit query string parameters with default value that are empty
    • Server interpreters should define it as A and accept incoming requests whose query string parameters with default value are missing, while providing the defined default value
    • Documentation interpreters should mark the parameter as optional and document the provided default value
    Definition Classes
    UrlsUrls

Operations

Operations creating and transforming values

  1. implicit final class EndpointSyntax[A, B] extends AnyRef

    Extension methods for Endpoint.

    Extension methods for Endpoint.

    Definition Classes
    EndpointsWithCustomErrors
  2. implicit final class RequestSyntax[A] extends AnyRef

    Extension methods for Request.

    Extension methods for Request.

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

    Extension methods for Response.

    Extension methods for Response.

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

    Convenient methods for Paths.

    Convenient methods for Paths.

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

    Extension methods on QueryString.

    Extension methods on QueryString.

    Definition Classes
    Urls
  1. abstract def clientErrorsResponseEntity: ResponseEntity[ClientErrors]

    Format of the response entity carrying the client errors.

    Format of the response entity carrying the client errors.

    Definition Classes
    Errors
  2. abstract def clientErrorsToInvalid(clientErrors: ClientErrors): Invalid

    Convert the ClientErrors type into the endpoints4s internal client error type

    Convert the ClientErrors type into the endpoints4s internal client error type

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

    Define an HTTP endpoint

    Define an HTTP endpoint

    request

    Request

    response

    Response

    docs

    Documentation (used by documentation interpreters)

    Definition Classes
    EndpointsWithCustomErrors
  4. abstract def invalidToClientErrors(invalid: Invalid): ClientErrors

    Convert the endpoints4s internal client error type into the ClientErrors type

    Convert the endpoints4s internal client error type into the ClientErrors type

    Definition Classes
    Errors
  5. abstract def serverErrorResponseEntity: ResponseEntity[ServerError]

    Format of the response entity carrying the server error.

    Format of the response entity carrying the server error.

    Definition Classes
    Errors
  6. abstract def serverErrorToThrowable(serverError: ServerError): Throwable

    Convert the ServerError type into the endpoints4s internal server error type

    Convert the ServerError type into the endpoints4s internal server error type

    Definition Classes
    Errors
  7. abstract def stringCodec[A](implicit arg0: JsonCodec[A]): Codec[String, A]

    Turns a JsonCodec[A] into a Codec[String, A]

    Turns a JsonCodec[A] into a Codec[String, A]

    Definition Classes
    JsonEntitiesFromCodecs
  8. abstract def throwableToServerError(throwable: Throwable): ServerError

    Convert the endpoints4s internal server error type into the ServerError type

    Convert the endpoints4s internal server error type into the ServerError type

    Definition Classes
    Errors
  9. def Accepted: Int

    Definition Classes
    StatusCodesStatusCodes
  10. def AlreadyReported: Int

    Definition Classes
    StatusCodesStatusCodes
  11. def BadRequest: Int

    Definition Classes
    StatusCodesStatusCodes
    Note

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

  12. def Conflict: Int

    Definition Classes
    StatusCodesStatusCodes
  13. def Created: Int

    Definition Classes
    StatusCodesStatusCodes
  14. def Delete: Method

    Definition Classes
    MethodsMethods
  15. def ExpectationFailed: Int

    Definition Classes
    StatusCodesStatusCodes
  16. def FailedDependency: Int

    Definition Classes
    StatusCodesStatusCodes
  17. def Forbidden: Int

    Definition Classes
    StatusCodesStatusCodes
  18. def Get: Method

    Definition Classes
    MethodsMethods
  19. def Gone: Int

    Definition Classes
    StatusCodesStatusCodes
  20. def IMUsed: Int

    Definition Classes
    StatusCodesStatusCodes
  21. def InternalServerError: Int

    Definition Classes
    StatusCodesStatusCodes
    Note

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

  22. def LengthRequired: Int

    Definition Classes
    StatusCodesStatusCodes
  23. def Locked: Int

    Definition Classes
    StatusCodesStatusCodes
  24. def MethodNotAllowed: Int

    Definition Classes
    StatusCodesStatusCodes
  25. def MisdirectedRequest: Int

    Definition Classes
    StatusCodesStatusCodes
  26. def MultiStatus: Int

    Definition Classes
    StatusCodesStatusCodes
  27. def NoContent: Int

    Definition Classes
    StatusCodesStatusCodes
  28. def NonAuthoritativeInformation: Int

    Definition Classes
    StatusCodesStatusCodes
  29. def NotAcceptable: Int

    Definition Classes
    StatusCodesStatusCodes
  30. def NotFound: Int

    Definition Classes
    StatusCodesStatusCodes
  31. def NotImplemented: Int

    Definition Classes
    StatusCodesStatusCodes
  32. def NotModified: Int

    Definition Classes
    StatusCodesStatusCodes
  33. def OK: Int

    Definition Classes
    StatusCodesStatusCodes
  34. def Options: Method

    Definition Classes
    MethodsMethods
  35. def PartialContent: Int

    Definition Classes
    StatusCodesStatusCodes
  36. def Patch: Method

    Definition Classes
    MethodsMethods
  37. def PayloadTooLarge: Int

    Definition Classes
    StatusCodesStatusCodes
  38. def PaymentRequired: Int

    Definition Classes
    StatusCodesStatusCodes
  39. def PermanentRedirect: Int

    Definition Classes
    StatusCodesStatusCodes
  40. def Post: Method

    Definition Classes
    MethodsMethods
  41. def PreconditionFailed: Int

    Definition Classes
    StatusCodesStatusCodes
  42. def PreconditionRequired: Int

    Definition Classes
    StatusCodesStatusCodes
  43. def ProxyAuthenticationRequired: Int

    Definition Classes
    StatusCodesStatusCodes
  44. def Put: Method

    Definition Classes
    MethodsMethods
  45. def RangeNotSatisfiable: Int

    Definition Classes
    StatusCodesStatusCodes
  46. def RequestHeaderFieldsTooLarge: Int

    Definition Classes
    StatusCodesStatusCodes
  47. def RequestTimeout: Int

    Definition Classes
    StatusCodesStatusCodes
  48. def ResetContent: Int

    Definition Classes
    StatusCodesStatusCodes
  49. def TemporaryRedirect: Int

    Definition Classes
    StatusCodesStatusCodes
  50. def TooEarly: Int

    Definition Classes
    StatusCodesStatusCodes
  51. def TooManyRequests: Int

    Definition Classes
    StatusCodesStatusCodes
  52. def Unauthorized: Int

    Definition Classes
    StatusCodesStatusCodes
  53. def UnavailableForLegalReasons: Int

    Definition Classes
    StatusCodesStatusCodes
  54. def UnprocessableEntity: Int

    Definition Classes
    StatusCodesStatusCodes
  55. def UnsupportedMediaType: Int

    Definition Classes
    StatusCodesStatusCodes
  56. def UpgradeRequired: Int

    Definition Classes
    StatusCodesStatusCodes
  57. def UriTooLong: Int

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

  59. implicit def booleanQueryString: QueryStringParam[Boolean]

    Query string parameter containing a Boolean value

    Query string parameter containing a Boolean value

    Definition Classes
    Urls
  60. 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
  61. 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
  62. implicit def doubleQueryString: QueryStringParam[Double]

    Codec for query string parameters of type Double

    Codec for query string parameters of type Double

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

    Path segment codec for type Double

    Path segment codec for type Double

    Definition Classes
    Urls
  64. lazy val emptyRequest: RequestEntity[Unit]

    Empty request -- request without a body.

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

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

    Ignore headers

    Ignore headers

    • Server interpreters don’t try to parse any information from the request headers,
    • Client interpreters supply no specific headers

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

    Definition Classes
    EndpointsWithCustomErrorsRequests
  66. 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
  67. def emptyResponseHeaders: ResponseHeaders[Unit]

    No particular response header.

    No particular response header.

    • Client interpreters should ignore information carried by response headers.
    Definition Classes
    EndpointsWithCustomErrorsResponses
  68. 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
  69. implicit def intQueryString: QueryStringParam[Int]

    Ability to define Int query string parameters

    Ability to define Int query string parameters

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

    Path segment codec for type Int

    Path segment codec for type Int

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

  72. def jsonRequest[A](implicit codec: JsonCodec[A]): (A, RequestInit) => Unit

    Request with a JSON body, given an implicit JsonRequest[A]

    Request with a JSON body, given an implicit JsonRequest[A]

    • Server interpreters accept requests with content-type application/json and reject requests with an incorrect content-type.
    • Client interpreters supply content-type application/json
    Definition Classes
    JsonEntitiesFromCodecsJsonEntities
  73. def jsonResponse[A](implicit codec: JsonCodec[A]): ResponseEntity[A]

    Defines a Response[A] given an implicit JsonResponse[A]

    Defines a Response[A] given an implicit JsonResponse[A]

    Definition Classes
    JsonEntitiesFromCodecsJsonEntities
  74. implicit def longQueryString: QueryStringParam[Long]

    Query string parameter containing a Long value

    Query string parameter containing a Long value

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

    Path segment codec for type Long

    Path segment codec for type Long

    Definition Classes
    Urls
  76. def mapEndpointDocs[A, B](endpoint: Endpoint[A, B], f: (EndpointDocs) => EndpointDocs): Endpoint[A, B]

    Map the inner documentation of the endpoint to new documentation.

    Map the inner documentation of the endpoint to new documentation.

    endpoint

    The current endpoint that is being mapped.

    returns

    The endpoint with the mapped documentation.

    Definition Classes
    EndpointsWithCustomErrorsEndpointsWithCustomErrors
  77. def mapEndpointRequest[A, B, C](endpoint: Endpoint[A, B], f: (Request[A]) => Request[C]): Endpoint[C, B]

    Map the inner request of the endpoint to a new request.

    Map the inner request of the endpoint to a new request. This is for example useful to add Auth headers to an existing endpoint.

    endpoint

    The current endpoint that is being mapped.

    returns

    The endpoint with the mapped request.

    Definition Classes
    EndpointsWithCustomErrorsEndpointsWithCustomErrors
    Example:
    1. val myEndpoint: Endpoint[Input, Output] = ???
      val basicAuthHeaders: RequestHeaders[Credentials] = ???
      
      val endpointWithAuth: Endpoint[(Input, Credentials), Output] =
        myEndpoint.mapRequest(_.addHeaders(basicAuthHeader))
  78. def mapEndpointResponse[A, B, C](endpoint: Endpoint[A, B], f: (Response[B]) => Response[C]): Endpoint[A, C]

    Map the inner response of the endpoint to a new response.

    Map the inner response of the endpoint to a new response. This is for example useful so you can add error handling to an existing endpoint.

    endpoint

    The current endpoint that is being mapped.

    returns

    The endpoint with the mapped response.

    Definition Classes
    EndpointsWithCustomErrorsEndpointsWithCustomErrors
    Example:
    1. val myEndpoint: Endpoint[Input, Output] = ???
      val errorResponse: Response[Error] = ???
      
      val endpointWithErrorHandling: Endpoint[Input, Either[Error, Output]] =
        myEndpoint.mapResponse(resp => resp orElse errorResponse)
  79. 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
  80. def optQsWithDefault[A](name: String, default: A, docs: Documentation = None)(implicit value: QueryStringParam[A]): QueryString[WithDefault[A]]

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

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

    Examples:

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

    Type of the value carried by the parameter

    name

    Parameter’s name

    Definition Classes
    UrlsUrls
  81. 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
  82. 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
  83. 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
  84. 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
  85. 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
  86. 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
  87. 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
  88. 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
  89. 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
  90. 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
  91. 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
  92. 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
  93. 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
  94. 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
  95. 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
  96. 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
  97. 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
  98. implicit lazy val stringQueryString: QueryStringParam[String]

    Ability to define String query string parameters

    Ability to define String query string parameters

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

    Path segment codec for type String

    Path segment codec for type String

    • Server interpreters should return an URL-decoded string value,
    • Client interpreters should take an URL-decoded string value.
    Definition Classes
    UrlsUrls
  100. lazy val textRequest: RequestEntity[String]

    Request with a String body.

    Request with a String body.

    • Server interpreters accept requests with content-type text/plain and reject requests with an incorrect content-type.
    • Server interpreters will use the character encoding set in the content-type header to determine how the text is decoded.
    • Client interpreters supply content-type text/plain with an explicit character encoding
    Definition Classes
    EndpointsWithCustomErrorsRequests
  101. 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
  102. implicit def uuidQueryString: QueryStringParam[UUID]

    Ability to define UUID query string parameters

    Ability to define UUID query string parameters

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

    Path segment codec for type UUID

    Path segment codec for type UUID

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

Ungrouped

  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. abstract class Endpoint[A, B] extends (A) => Result[B]
    Definition Classes
    EndpointsWithCustomErrors
  8. trait Request[A] extends AnyRef
    Definition Classes
    EndpointsWithCustomErrors
  9. implicit class RequestInitOps extends AnyRef
    Definition Classes
    EndpointsWithCustomErrors
  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 Result[A]
    Definition Classes
    EndpointsWithCustomErrors
  12. trait Path[A] extends Url[A]

    Builds an URL path from an A

    Builds an URL path from an A

    Definition Classes
    Urls
  13. trait QueryString[A] extends AnyRef

    Defines how to build a query string from an A

    Defines how to build a query string from an A

    Definition Classes
    Urls
  14. trait QueryStringParam[A] extends AnyRef

    Defines how to build a query string parameter value from an A

    Defines how to build a query string parameter value from an A

    Definition Classes
    Urls
  15. trait Segment[A] extends AnyRef

    Defines how to build a path segment from an A

    Defines how to build a path segment from an A

    Definition Classes
    Urls
  16. trait Url[A] extends AnyRef

    Builds an URL from an A

    Builds an URL from an A

    Definition Classes
    Urls
  1. abstract def settings: EndpointsSettings
    Definition Classes
    EndpointsWithCustomErrors
  2. object CallbackDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  3. object EndpointDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  4. def addRequestHeaders[A, H](request: Request[A], headers: RequestHeaders[H])(implicit tupler: Tupler[A, H]): Request[Out]

    Add the provided headers to the request.

    Add the provided headers to the request.

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

    Add the provided queryString to the request.

    Add the provided queryString to the request.

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

    Add the provided headers to the response.

    Add the provided headers to the response.

    Note that if the response describes a choice of several possible responses (resulting from the orElse operation), the headers will be added to all the possible responses.

    Definition Classes
    EndpointsWithCustomErrorsResponses
  7. 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
  8. 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
  9. 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
  10. 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
  11. implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]

    Provides xmap and xmapPartial operations.

    Provides xmap and xmapPartial operations.

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  12. implicit lazy val queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]

    Provides xmap and xmapPartial operations.

    Provides xmap and xmapPartial operations.

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  13. implicit lazy val queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]

    Provides xmap and xmapPartial operations.

    Provides xmap and xmapPartial operations.

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  14. implicit lazy val requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]

    Provides the operations xmap and xmapPartial.

    Provides the operations xmap and xmapPartial.

    Definition Classes
    EndpointsWithCustomErrorsRequests
    See also

    PartialInvariantFunctorSyntax

  15. implicit lazy val requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]

    Provides the operations xmap and xmapPartial.

    Provides the operations xmap and xmapPartial.

    Definition Classes
    EndpointsWithCustomErrorsRequests
    See also

    PartialInvariantFunctorSyntax

  16. implicit lazy val requestHeadersSemigroupal: Semigroupal[RequestHeaders]

    Provides ++ operation.

    Provides ++ operation.

    Definition Classes
    EndpointsWithCustomErrorsRequests
    See also

    SemigroupalSyntax

  17. implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]

    Provides the operations xmap and xmapPartial.

    Provides the operations xmap and xmapPartial.

    Definition Classes
    EndpointsWithCustomErrorsRequests
    See also

    PartialInvariantFunctorSyntax

  18. implicit def responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
    Definition Classes
    EndpointsWithCustomErrorsResponses
  19. implicit def responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]

    Provides xmap operation.

    Provides xmap operation.

    Definition Classes
    EndpointsWithCustomErrorsResponses
    See also

    InvariantFunctorSyntax

  20. implicit def responseHeadersSemigroupal: Semigroupal[ResponseHeaders]

    Provides ++ operation.

    Provides ++ operation.

    Definition Classes
    EndpointsWithCustomErrorsResponses
    See also

    SemigroupalSyntax

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

  22. implicit lazy val segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]

    Provides xmap and xmapPartial operations.

    Provides xmap and xmapPartial operations.

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

  23. def stringCodecResponse[A](implicit codec: Decoder[String, A]): ResponseEntity[A]
    Definition Classes
    EndpointsWithCustomErrors
  24. implicit lazy val urlPartialInvariantFunctor: PartialInvariantFunctor[Url]

    Provides xmap and xmapPartial operations

    Provides xmap and xmapPartial operations

    Definition Classes
    UrlsUrls
    See also

    PartialInvariantFunctorSyntax and InvariantFunctorSyntax

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