MuxEndpoints

trait MuxEndpoints extends algebra.MuxEndpoints with EndpointsWithCustomErrors

Source: MuxEndpoints.scala

Type Hierarchy

Ordering

Grouped
Alphabetic
By Inheritance

Inherited

MuxEndpoints
EndpointsWithCustomErrors
Responses
StatusCodes
Requests
Headers
Methods
Urls
MuxEndpoints
EndpointsWithCustomErrors
Errors
Responses
StatusCodes
Requests
SemigroupalSyntax
Methods
Urls
PartialInvariantFunctorSyntax
InvariantFunctorSyntax
AnyRef
Any

Implicitly

by any2stringadd
by StringFormat
by Ensuring
by ArrowAssoc

Hide All
Show All

Visibility

Public
Protected

Type Members

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
implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
Definition Classes
PartialInvariantFunctorSyntax
implicit class SemigroupalSyntax[A, F[_]] extends AnyRef
Definition Classes
SemigroupalSyntax
final class CallbackDocs extends Serializable
Definition Classes
EndpointsWithCustomErrors
final class EndpointDocs extends Serializable
Definition Classes
EndpointsWithCustomErrors
implicit final class EndpointSyntax[A, B] extends AnyRef
Extension methods for Endpoint.
Extension methods for Endpoint.
Definition Classes
EndpointsWithCustomErrors
implicit class RequestEntitySyntax[A] extends AnyRef
Definition Classes
Requests
implicit final class RequestSyntax[A] extends AnyRef
Extension methods for Request.
Extension methods for Request.
Definition Classes
Requests
implicit class ResponseSyntax[A] extends AnyRef
Extension methods for Response.
Extension methods for Response.
Definition Classes
Responses
implicit class PathOps[A] extends AnyRef
Convenient methods for Paths.
Convenient methods for Paths.
Definition Classes
Urls
implicit class QueryStringSyntax[A] extends AnyRef
Extension methods on QueryString.
Extension methods on QueryString.
Definition Classes
Urls
case class DocumentedEndpoint(request: EndpointsWithCustomErrors.DocumentedRequest, response: List[EndpointsWithCustomErrors.DocumentedResponse], securityRequirements: Seq[SecurityRequirement], docs: EndpointsWithCustomErrors.EndpointDocs) extends Product with Serializable
Definition Classes
EndpointsWithCustomErrors
case class DocumentedHeader(name: String, description: Option[String], required: Boolean, schema: Schema) extends Product with Serializable
Definition Classes
Headers
case class DocumentedHeaders(value: List[DocumentedHeader]) extends Product with Serializable
value
List of request header names (e.g. “Authorization”)
Definition Classes
Headers
sealed trait Method extends AnyRef
Definition Classes
Methods
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/
abstract type ClientErrors
Errors in a request built by a client
Errors in a request built by a client
Definition Classes
Errors
type Endpoint[A, B] = DocumentedEndpoint
Information carried by an HTTP endpoint
Information carried by an HTTP endpoint
Values of type Endpoint can be constructed by using the operation endpoint.
Definition Classes
EndpointsWithCustomErrors → EndpointsWithCustomErrors
Note
This type has implicit methods provided by the EndpointSyntax class
type MuxEndpoint[Req <: MuxRequest, Resp, Transport] = DocumentedEndpoint
Information carried by a multiplexed HTTP endpoint.
Information carried by a multiplexed HTTP endpoint.
Definition Classes
MuxEndpoints → MuxEndpoints
type Path[A] = DocumentedUrl
An URL path carrying an A information
An URL path carrying an A information
Values of type Path[A] can be constructed by the operations path, segment, and remainingSegments.
```
path / "user" / segment[UUID]("id")
```
- Server interpreters raise an error if they can’t parse the incoming request path 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
Urls → Urls
Note
This type has implicit methods provided by the PathOps, InvariantFunctorSyntax, and the PartialInvariantFunctorSyntax classes.
type QueryString[A] = DocumentedQueryString
A query string carrying an A information
A query string carrying an A information
QueryString values can be created with the qs operation, and can be combined with the & operation:
```
val queryPageAndLang: QueryString[(Int, Option[String])] =
  qs[Int]("page") & qs[Option[String]]("lang")
```
- Server interpreters raise an error if they can’t parse the incoming request query string parameters as a value of type A. By default, they produce a Bad Request (400) response with a list of error messages in a JSON array. Refer to the documentation of your server interpreter to customize this behavior.
Definition Classes
Urls → Urls
Note
This type has implicit methods provided by the QueryStringSyntax, InvariantFunctorSyntax, and the PartialInvariantFunctorSyntax classes.
type QueryStringParam[A] = DocumentedQueryStringParam[A]
A query string parameter codec for type A.
A query string parameter codec for type A.
The trait Urls provides implicit instances of type QueryStringParam[A] for basic types (e.g., Int, String, etc.). You can create additional instances by transforming or refining the existing instances with xmap and xmapPartial.
Definition Classes
Urls → Urls
Note
This type has implicit methods provided by the PartialInvariantFunctorSyntax and the InvariantFunctorSyntax classes.
type Request[A] = DocumentedRequest
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
Requests → Requests
Note
This type has implicit methods provided by the PartialInvariantFunctorSyntax and RequestSyntax classes.
type RequestEntity[A] = Map[String, MediaType]
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
Requests → Requests
Note
This type has implicit methods provided by the PartialInvariantFunctorSyntax and RequestEntitySyntax classes.
type RequestHeaders[A] = DocumentedHeaders
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
Requests → Requests
Note
This type has implicit methods provided by the SemigroupalSyntax and PartialInvariantFunctorSyntax classes.
type Response[A] = List[DocumentedResponse]
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
Responses → Responses
Note
This type has implicit methods provided by the InvariantFunctorSyntax and ResponseSyntax classes
type ResponseEntity[A] = Map[String, MediaType]
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
Responses → Responses
Note
This type has implicit methods provided by the InvariantFunctorSyntax class
type ResponseHeaders[A] = DocumentedHeaders
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
Responses → Responses
Note
This type has implicit methods provided by the SemigroupalSyntax and InvariantFunctorSyntax classes.
type Segment[A] = Schema
An URL path segment codec for type A.
An URL path segment codec for type A.
The trait Urls provides implicit instances of Segment[A] for basic types (e.g., Int, String, etc.). You can create additional instances by transforming or refining the existing instances with xmap and xmapPartial.
Definition Classes
Urls → Urls
Note
This type has implicit methods provided by the PartialInvariantFunctorSyntax and the InvariantFunctorSyntax classes.
abstract type ServerError
Error raised by the business logic of a server
Error raised by the business logic of a server
Definition Classes
Errors
type StatusCode = Int
HTTP Status Code
HTTP Status Code
Definition Classes
StatusCodes → StatusCodes
type Url[A] = DocumentedUrl
An URL carrying an A information
An URL carrying an A information
Values of type URL[A] are typically constructed by first using the path constructor and then chaining it with segments and query parameters.
```
path / "users" / segment[UUID]("id") /? qs[String]("apiKey")
```
- Server interpreters raise an error if they can’t parse the incoming request URL 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
Urls → Urls
Note
This type has implicit methods provided by the PartialInvariantFunctorSyntax and InvariantFunctorSyntax classes.
type WithDefault[A] = 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
Urls → Urls
case class DocumentedRequest(method: Requests.Method, url: Requests.DocumentedUrl, headers: Requests.DocumentedHeaders, documentation: Documentation, entity: Map[String, MediaType]) extends Product with Serializable
Definition Classes
Requests
case class DocumentedResponse(status: (Responses.this)#StatusCode, documentation: String, headers: (Responses.this)#DocumentedHeaders, content: Map[String, MediaType]) extends Product with Serializable
status
Response status code (e.g. OK or NotFound)
documentation
Human readable documentation. Not optional because its required by openapi
headers
Response headers documentation
content
Map that associates each possible content-type (e.g. “text/html”) with a MediaType description
Definition Classes
Responses
case class DocumentedParameter(name: String, required: Boolean, description: Option[String], schema: Schema) extends Product with Serializable
name
Name of the parameter
required
Whether this parameter is required or not (MUST be true for path parameters)
Definition Classes
Urls
case class DocumentedQueryString(parameters: List[DocumentedParameter]) extends Product with Serializable
parameters
List of query string parameters
Definition Classes
Urls
case class DocumentedQueryStringParam[A](schema: Schema, isRequired: Boolean, encoder: Encoder[A, Option[Value]]) extends Product with Serializable
A query string parameter documentation description for type A
A query string parameter documentation description for type A
schema
Schema that corresponds to type A
isRequired
Whether the query string parameter is required
encoder
JSON encoder for query string parameter value, primarily used for encoding of the parameter's default value. Result of the encoding is optional since the empty value of optional query string parameter should result in the empty encoded value.
Definition Classes
Urls
case class DocumentedUrl(path: List[Either[String, DocumentedParameter]], queryParameters: List[DocumentedParameter]) extends Product with Serializable
path
List of path segments. Left is a static segment, right is a path parameter
queryParameters
Query string parameters
Definition Classes
Urls

Abstract Value Members

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
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
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
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
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
abstract def throwableToServerError(throwable: Throwable): ServerError
Convert the endpoints4s internal server error type into the ServerError type
Convert the endpoints4s internal server error type into the ServerError type
Definition Classes
Errors

Concrete Value Members

object CallbackDocs extends Serializable
Definition Classes
EndpointsWithCustomErrors
object EndpointDocs extends Serializable
Definition Classes
EndpointsWithCustomErrors
case object Delete extends Method with Product with Serializable
Definition Classes
Methods → Methods
case object Get extends Method with Product with Serializable
Definition Classes
Methods → Methods
case object Options extends Method with Product with Serializable
Definition Classes
Methods → Methods
case object Patch extends Method with Product with Serializable
Definition Classes
Methods → Methods
case object Post extends Method with Product with Serializable
Definition Classes
Methods → Methods
case object Put extends Method with Product with Serializable
Definition Classes
Methods → Methods
final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
def +(other: String): String
Implicit
This member is added by an implicit conversion from MuxEndpoints toany2stringadd[MuxEndpoints] performed by method any2stringadd in scala.Predef.
Definition Classes
any2stringadd
def ->[B](y: B): (MuxEndpoints, B)
Implicit
This member is added by an implicit conversion from MuxEndpoints toArrowAssoc[MuxEndpoints] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
def Accepted: Int
Definition Classes
StatusCodes → StatusCodes
def AlreadyReported: Int
Definition Classes
StatusCodes → StatusCodes
def BadRequest: Int
Definition Classes
StatusCodes → StatusCodes
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.
def Conflict: Int
Definition Classes
StatusCodes → StatusCodes
def Created: Int
Definition Classes
StatusCodes → StatusCodes
def ExpectationFailed: Int
Definition Classes
StatusCodes → StatusCodes
def FailedDependency: Int
Definition Classes
StatusCodes → StatusCodes
def Forbidden: Int
Definition Classes
StatusCodes → StatusCodes
def Gone: Int
Definition Classes
StatusCodes → StatusCodes
def IMUsed: Int
Definition Classes
StatusCodes → StatusCodes
def InternalServerError: Int
Definition Classes
StatusCodes → StatusCodes
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.
def LengthRequired: Int
Definition Classes
StatusCodes → StatusCodes
def Locked: Int
Definition Classes
StatusCodes → StatusCodes
def MethodNotAllowed: Int
Definition Classes
StatusCodes → StatusCodes
def MisdirectedRequest: Int
Definition Classes
StatusCodes → StatusCodes
def MultiStatus: Int
Definition Classes
StatusCodes → StatusCodes
def NoContent: Int
Definition Classes
StatusCodes → StatusCodes
def NonAuthoritativeInformation: Int
Definition Classes
StatusCodes → StatusCodes
def NotAcceptable: Int
Definition Classes
StatusCodes → StatusCodes
def NotFound: Int
Definition Classes
StatusCodes → StatusCodes
def NotImplemented: Int
Definition Classes
StatusCodes → StatusCodes
def NotModified: Int
Definition Classes
StatusCodes → StatusCodes
def OK: Int
Definition Classes
StatusCodes → StatusCodes
def PartialContent: Int
Definition Classes
StatusCodes → StatusCodes
def PayloadTooLarge: Int
Definition Classes
StatusCodes → StatusCodes
def PaymentRequired: Int
Definition Classes
StatusCodes → StatusCodes
def PermanentRedirect: Int
Definition Classes
StatusCodes → StatusCodes
def PreconditionFailed: Int
Definition Classes
StatusCodes → StatusCodes
def PreconditionRequired: Int
Definition Classes
StatusCodes → StatusCodes
def ProxyAuthenticationRequired: Int
Definition Classes
StatusCodes → StatusCodes
def RangeNotSatisfiable: Int
Definition Classes
StatusCodes → StatusCodes
def RequestHeaderFieldsTooLarge: Int
Definition Classes
StatusCodes → StatusCodes
def RequestTimeout: Int
Definition Classes
StatusCodes → StatusCodes
def ResetContent: Int
Definition Classes
StatusCodes → StatusCodes
def TemporaryRedirect: Int
Definition Classes
StatusCodes → StatusCodes
def TooEarly: Int
Definition Classes
StatusCodes → StatusCodes
def TooManyRequests: Int
Definition Classes
StatusCodes → StatusCodes
def Unauthorized: Int
Definition Classes
StatusCodes → StatusCodes
def UnavailableForLegalReasons: Int
Definition Classes
StatusCodes → StatusCodes
def UnprocessableEntity: Int
Definition Classes
StatusCodes → StatusCodes
def UnsupportedMediaType: Int
Definition Classes
StatusCodes → StatusCodes
def UpgradeRequired: Int
Definition Classes
StatusCodes → StatusCodes
def UriTooLong: Int
Definition Classes
StatusCodes → StatusCodes
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
Requests → Requests
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
Requests → Requests
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
Responses → Responses
final def asInstanceOf[T0]: T0
Definition Classes
Any
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
def booleanQueryString: QueryStringParam[Boolean]
Query string parameter containing a Boolean value
Query string parameter containing a Boolean value
Definition Classes
Urls → Urls
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
Urls → Urls
def choiceRequestEntity[A, B](requestEntityA: Map[String, MediaType], requestEntityB: Map[String, MediaType]): Map[String, MediaType]
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
Requests → Requests
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
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
Responses → Responses
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
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
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
Urls → Urls
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
def doubleQueryString: QueryStringParam[Double]
Codec for query string parameters of type Double
Codec for query string parameters of type Double
Definition Classes
Urls → Urls
def doubleSegment: Segment[Double]
Path segment codec for type Double
Path segment codec for type Double
Definition Classes
Urls → Urls
lazy val emptyRequest: Map[String, MediaType]
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
Requests → Requests
def emptyRequestHeaders: DocumentedHeaders
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
Requests → Requests
def emptyResponse: ResponseEntity[Unit]
Empty response entity
Empty response entity
- Server interpreters produce no response entity,
- Client interpreters ignore the response entity.
Definition Classes
Responses → Responses
def emptyResponseHeaders: ResponseHeaders[Unit]
No particular response header.
No particular response header.
- Client interpreters should ignore information carried by response headers.
Definition Classes
Responses → Responses
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 → EndpointsWithCustomErrors
def ensuring(cond: (MuxEndpoints) => Boolean, msg: => Any): MuxEndpoints
Implicit
This member is added by an implicit conversion from MuxEndpoints toEnsuring[MuxEndpoints] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (MuxEndpoints) => Boolean): MuxEndpoints
Implicit
This member is added by an implicit conversion from MuxEndpoints toEnsuring[MuxEndpoints] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: => Any): MuxEndpoints
Implicit
This member is added by an implicit conversion from MuxEndpoints toEnsuring[MuxEndpoints] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): MuxEndpoints
Implicit
This member is added by an implicit conversion from MuxEndpoints toEnsuring[MuxEndpoints] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
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
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@IntrinsicCandidate() @native()
def intQueryString: QueryStringParam[Int]
Ability to define Int query string parameters
Ability to define Int query string parameters
Definition Classes
Urls → Urls
def intSegment: Segment[Int]
Path segment codec for type Int
Path segment codec for type Int
Definition Classes
Urls → Urls
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
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
def longQueryString: QueryStringParam[Long]
Query string parameter containing a Long value
Query string parameter containing a Long value
Definition Classes
Urls → Urls
def longSegment: Segment[Long]
Path segment codec for type Long
Path segment codec for type Long
Definition Classes
Urls → Urls
def mapEndpointDocs[A, B](currentEndpoint: Endpoint[A, B], func: (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.
func
The function that maps the documentation to some new documentation.
returns
The endpoint with the mapped documentation.
Definition Classes
EndpointsWithCustomErrors → EndpointsWithCustomErrors
def mapEndpointRequest[A, B, C](currentEndpoint: Endpoint[A, B], func: (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.
func
The function that maps the request to some new request.
returns
The endpoint with the mapped request.
Definition Classes
EndpointsWithCustomErrors → EndpointsWithCustomErrors
Example:
1. val myEndpoint: Endpoint[Input, Output] = ??? val basicAuthHeaders: RequestHeaders[Credentials] = ??? val endpointWithAuth: Endpoint[(Input, Credentials), Output] = myEndpoint.mapRequest(_.addHeaders(basicAuthHeader))
def mapEndpointResponse[A, B, C](currentEndpoint: Endpoint[A, B], func: (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.
func
The function that maps the response to some new response.
returns
The endpoint with the mapped response.
Definition Classes
EndpointsWithCustomErrors → EndpointsWithCustomErrors
Example:
1. val myEndpoint: Endpoint[Input, Output] = ??? val errorResponse: Response[Error] = ??? val endpointWithErrorHandling: Endpoint[Input, Either[Error, Output]] = myEndpoint.mapResponse(resp => resp orElse errorResponse)
def muxEndpoint[Req <: MuxRequest, Resp, Transport](request: Request[Transport], response: Response[Transport]): MuxEndpoint[Req, Resp, Transport]
Multiplexed HTTP endpoint.
Multiplexed HTTP endpoint.
A multiplexing endpoint makes it possible to use several request and response types in the same HTTP endpoint. In other words, it allows to define several different actions through a singe HTTP endpoint.
Req
The base type of possible requests
Resp
The base type of possible responses
Transport
The data type used to transport the requests and responses
request
The request
response
The response
Definition Classes
MuxEndpoints → MuxEndpoints
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@IntrinsicCandidate() @native()
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
def openApi(info: Info)(endpoints: DocumentedEndpoint*): OpenApi
info
General information about the documentation to generate
endpoints
The endpoints to generate the documentation for
returns
An OpenApi instance for the given endpoint descriptions
Definition Classes
EndpointsWithCustomErrors
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
Urls → Urls
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
Requests → Requests
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
Responses → Responses
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
Urls → Urls
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
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
implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]
Provides xmap and xmapPartial operations.
Provides xmap and xmapPartial operations.
Definition Classes
Urls → Urls
See also
PartialInvariantFunctorSyntax and InvariantFunctorSyntax
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
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
def qs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[A]
Builds a QueryString with one parameter.
Builds a QueryString with one parameter.
Examples:
```
qs[Int]("page")            // mandatory `page` parameter
qs[Option[String]]("lang") // optional `lang` parameter
qs[List[Long]]("id")       // repeated `id` parameter
```
A
Type of the value carried by the parameter
name
Parameter’s name
Definition Classes
Urls → Urls
implicit lazy val queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]
Provides xmap and xmapPartial operations.
Provides xmap and xmapPartial operations.
Definition Classes
Urls → Urls
See also
PartialInvariantFunctorSyntax and InvariantFunctorSyntax
implicit lazy val queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]
Provides xmap and xmapPartial operations.
Provides xmap and xmapPartial operations.
Definition Classes
Urls → Urls
See also
PartialInvariantFunctorSyntax and InvariantFunctorSyntax
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
Urls → Urls
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
Urls → Urls
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
Requests → Requests
implicit lazy val requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]
Provides the operations xmap and xmapPartial.
Provides the operations xmap and xmapPartial.
Definition Classes
Requests → Requests
See also
PartialInvariantFunctorSyntax
def requestHeader(name: String, docs: Documentation): RequestHeaders[String]
A required request header
A required request header
name
Header name (e.g., “Authorization”)
Definition Classes
Requests → Requests
implicit lazy val requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]
Provides the operations xmap and xmapPartial.
Provides the operations xmap and xmapPartial.
Definition Classes
Requests → Requests
See also
PartialInvariantFunctorSyntax
implicit lazy val requestHeadersSemigroupal: Semigroupal[RequestHeaders]
Provides ++ operation.
Provides ++ operation.
Definition Classes
Requests → Requests
See also
SemigroupalSyntax
implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]
Provides the operations xmap and xmapPartial.
Provides the operations xmap and xmapPartial.
Definition Classes
Requests → Requests
See also
PartialInvariantFunctorSyntax
def response[A, B, R](statusCode: StatusCode, entity: ResponseEntity[A], docs: Documentation = None, headers: ResponseHeaders[B])(implicit tupler: Tupler.Aux[A, B, R]): Response[R]
Define an HTTP response
Define an HTTP response
- Server interpreters construct a response with the given status and entity.
- Client interpreters accept a response only if it has a corresponding status code.
statusCode
Response status code
entity
Response entity
docs
Response documentation
headers
Response headers
Definition Classes
Responses → Responses
implicit lazy val responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
Definition Classes
Responses → Responses
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
Responses → Responses
implicit def responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]
Provides xmap operation.
Provides xmap operation.
Definition Classes
Responses → Responses
See also
InvariantFunctorSyntax
implicit def responseHeadersSemigroupal: Semigroupal[ResponseHeaders]
Provides ++ operation.
Provides ++ operation.
Definition Classes
Responses → Responses
See also
SemigroupalSyntax
implicit lazy val responseInvariantFunctor: InvariantFunctor[Response]
Provides the operation xmap to the type Response
Provides the operation xmap to the type Response
Definition Classes
Responses → Responses
See also
InvariantFunctorSyntax
def segment[A](name: String, docs: Documentation)(implicit A: Segment[A]): Path[A]
A path segment carrying an A information
A path segment carrying an A information
Definition Classes
Urls → Urls
implicit lazy val segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]
Provides xmap and xmapPartial operations.
Provides xmap and xmapPartial operations.
Definition Classes
Urls → Urls
See also
PartialInvariantFunctorSyntax and InvariantFunctorSyntax
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
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
Urls → Urls
def stringQueryString: QueryStringParam[String]
Ability to define String query string parameters
Ability to define String query string parameters
Definition Classes
Urls → Urls
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
Urls → Urls
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
lazy val textRequest: Map[String, MediaType]
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
Requests → Requests
def textResponse: ResponseEntity[String]
Text response entity
Text response entity
- Server interpreters produce an HTTP response with a text/plain content type.
Definition Classes
Responses → Responses
def toString(): String
Definition Classes
AnyRef → Any
implicit lazy val urlPartialInvariantFunctor: PartialInvariantFunctor[Url]
Provides xmap and xmapPartial operations
Provides xmap and xmapPartial operations
Definition Classes
Urls → Urls
See also
PartialInvariantFunctorSyntax and InvariantFunctorSyntax
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
Urls → Urls
def uuidQueryString: QueryStringParam[UUID]
Ability to define UUID query string parameters
Ability to define UUID query string parameters
Definition Classes
Urls → Urls
def uuidSegment: Segment[UUID]
Path segment codec for type UUID
Path segment codec for type UUID
Definition Classes
Urls → Urls
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
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

def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable]) @Deprecated
Deprecated
(Since version 9)
def formatted(fmtstr: String): String
Implicit
This member is added by an implicit conversion from MuxEndpoints toStringFormat[MuxEndpoints] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@deprecated @inline()
Deprecated
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
def →[B](y: B): (MuxEndpoints, B)
Implicit
This member is added by an implicit conversion from MuxEndpoints toArrowAssoc[MuxEndpoints] 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 EndpointsWithCustomErrors

Inherited from Responses

Packages

MuxEndpoints

trait MuxEndpoints extends algebra.MuxEndpoints with EndpointsWithCustomErrors

Type Members

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from EndpointsWithCustomErrors

Inherited from Responses

Inherited from StatusCodes

Inherited from Requests

Inherited from Headers

Inherited from Methods

Inherited from Urls

Inherited from algebra.MuxEndpoints

Inherited from algebra.EndpointsWithCustomErrors

Inherited from Errors

Inherited from algebra.Responses

Inherited from algebra.StatusCodes

Inherited from algebra.Requests

Inherited from endpoints4s.SemigroupalSyntax

Inherited from algebra.Methods

Inherited from algebra.Urls

Inherited from endpoints4s.PartialInvariantFunctorSyntax

Inherited from endpoints4s.InvariantFunctorSyntax

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromMuxEndpoints to any2stringadd[MuxEndpoints]

Inherited by implicit conversion StringFormat fromMuxEndpoints to StringFormat[MuxEndpoints]

Inherited by implicit conversion Ensuring fromMuxEndpoints to Ensuring[MuxEndpoints]

Inherited by implicit conversion ArrowAssoc fromMuxEndpoints to ArrowAssoc[MuxEndpoints]

Types

Operations

Ungrouped

Packages

MuxEndpoints

trait MuxEndpoints extends algebra.MuxEndpoints with EndpointsWithCustomErrors

Type Members

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from EndpointsWithCustomErrors

Inherited from Responses

Inherited from StatusCodes

Inherited from Requests

Inherited from Headers

Inherited from Methods

Inherited from Urls

Inherited from algebra.MuxEndpoints

Inherited from algebra.EndpointsWithCustomErrors

Inherited from Errors

Inherited from algebra.Responses

Inherited from algebra.StatusCodes

Inherited from algebra.Requests

Inherited from endpoints4s.SemigroupalSyntax

Inherited from algebra.Methods

Inherited from algebra.Urls

Inherited from endpoints4s.PartialInvariantFunctorSyntax

Inherited from endpoints4s.InvariantFunctorSyntax

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromMuxEndpoints to any2stringadd[MuxEndpoints]

Inherited by implicit conversion StringFormat fromMuxEndpoints to StringFormat[MuxEndpoints]

Inherited by implicit conversion Ensuring fromMuxEndpoints to Ensuring[MuxEndpoints]

Inherited by implicit conversion ArrowAssoc fromMuxEndpoints to ArrowAssoc[MuxEndpoints]

Types

Operations

Ungrouped

MuxEndpoints