Endpoints

Type Members

case class CallbackDocs extends Product with Serializable

Definition Classes
EndpointsWithCustomErrors
type CallbacksDocs = Map[String, CallbackDocs]

Definition Classes
EndpointsWithCustomErrors
type ClientErrors = Invalid

Definition Classes
BuiltInErrors → Errors
case class Endpoint[A, B](request: Request[A], response: Response[B]) extends Product with Serializable

Definition Classes
EndpointsWithCustomErrors
case class EndpointDocs extends Product with Serializable

Definition Classes
EndpointsWithCustomErrors
implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef

Definition Classes
InvariantFunctorSyntax
type Method = HttpMethod

Definition Classes
Methods → Methods
implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef

Definition Classes
PartialInvariantFunctorSyntax
trait Path[A] extends EndpointsWithCustomErrors.Url[A]

Definition Classes
Urls
implicit class PathOps[A] extends AnyRef

Definition Classes
Urls
trait QueryString[T] extends AnyRef

Definition Classes
Urls
type QueryStringParam[T] = (String, Map[String, Seq[String]]) ⇒ Validated[T]

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

Definition Classes
Urls → Urls
implicit class QueryStringSyntax[A] extends AnyRef

Definition Classes
Urls
type Request[A] = Directive[(A)]

Definition Classes
EndpointsWithCustomErrors → Requests
type RequestEntity[A] = Directive[(A)]

Definition Classes
EndpointsWithCustomErrors → Requests
type RequestHeaders[A] = Directive[(A)]

Definition Classes
EndpointsWithCustomErrors → Requests
type Response[A] = (A) ⇒ Route

Definition Classes
EndpointsWithCustomErrors → Responses
type ResponseEntity[A] = Marshaller[A, MessageEntity]

Definition Classes
EndpointsWithCustomErrors → Responses
implicit class ResponseSyntax[A] extends AnyRef

Definition Classes
Responses
trait Segment[A] extends AnyRef

Definition Classes
Urls
implicit class SemigroupalSyntax[A, F[_]] extends AnyRef

Definition Classes
SemigroupalSyntax
type ServerError = Throwable

Definition Classes
BuiltInErrors → Errors
type StatusCode = akka.http.scaladsl.model.StatusCode

Definition Classes
StatusCodes → StatusCodes
trait Url[A] extends AnyRef

Definition Classes
Urls

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def Accepted: Success

Definition Classes
StatusCodes → StatusCodes
def BadRequest: ClientError

Definition Classes
StatusCodes → StatusCodes
def Created: Success

Definition Classes
StatusCodes → StatusCodes
def Delete: HttpMethod

Definition Classes
Methods → Methods
def Forbidden: ClientError

Definition Classes
StatusCodes → StatusCodes
def Get: HttpMethod

Definition Classes
Methods → Methods
def InternalServerError: akka.http.scaladsl.model.StatusCodes.ServerError

Definition Classes
StatusCodes → StatusCodes
def NoContent: Success

Definition Classes
StatusCodes → StatusCodes
def NotFound: ClientError

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

Definition Classes
StatusCodes → StatusCodes
def OK: Success

Definition Classes
StatusCodes → StatusCodes
def Options: HttpMethod

Definition Classes
Methods → Methods
def Patch: HttpMethod

Definition Classes
Methods → Methods
def Post: HttpMethod

Definition Classes
Methods → Methods
def Put: HttpMethod

Definition Classes
Methods → Methods
def Unauthorized: ClientError

Definition Classes
StatusCodes → StatusCodes
final def asInstanceOf[T0]: T0

Definition Classes
Any
final def badRequest(docs: Documentation): Response[ClientErrors]

Definition Classes
Responses
implicit def booleanQueryString: QueryStringParam[Boolean]

Definition Classes
Urls
def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]

Definition Classes
Urls → Urls
def choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]

Definition Classes
EndpointsWithCustomErrors → Responses
lazy val clientErrorsResponse: Response[ClientErrors]

Definition Classes
Errors
def clientErrorsResponseEntity: ResponseEntity[Invalid]

Definition Classes
BuiltInErrors → BuiltInErrors → Errors
final def clientErrorsToInvalid(clientErrors: ClientErrors): Invalid

Definition Classes
BuiltInErrors → Errors
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]

Definition Classes
Urls → Urls
def convToDirective1(directive: Directive0): Directive1[Unit]

Attributes
protected
Definition Classes
Urls
final def delete[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]

Definition Classes
Requests
lazy val directive1InvFunctor: InvariantFunctor[Directive1]

Definition Classes
EndpointsWithCustomErrors
implicit def doubleQueryString: QueryStringParam[Double]

Definition Classes
Urls
implicit def doubleSegment: Segment[Double]

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

Definition Classes
Urls
def emptyHeaders: RequestHeaders[Unit]

Definition Classes
EndpointsWithCustomErrors → Requests
def emptyRequest: RequestEntity[Unit]

Definition Classes
EndpointsWithCustomErrors → Requests
def emptyResponse: ResponseEntity[Unit]

Definition Classes
EndpointsWithCustomErrors → Responses
def endpoint[A, B](request: Request[A], response: Response[B], docs: EndpointDocs = EndpointDocs()): Endpoint[A, B]

Definition Classes
EndpointsWithCustomErrors → EndpointsWithCustomErrors
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def get[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]

Definition Classes
Requests
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def handleClientErrors(invalid: Invalid): StandardRoute

This method is called by endpoints when decoding a request failed.
This method is called by endpoints when decoding a request failed.
The provided implementation calls clientErrorsResponse to complete with a response containing the errors.
This method can be overridden to customize the error reporting logic.

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

This method is called by endpoints when an exception is thrown during request processing.
This method is called by endpoints when an exception is thrown during request processing.
The provided implementation uses serverErrorResponse to complete with a response containing the error message.
This method can be overridden to customize the error reporting logic.

Definition Classes
EndpointsWithCustomErrors
def hashCode(): Int

Definition Classes
AnyRef → Any
def header(name: String, docs: Documentation): RequestHeaders[String]

Definition Classes
EndpointsWithCustomErrors → Requests
implicit def intQueryString: QueryStringParam[Int]

Definition Classes
Urls
implicit def intSegment: Segment[Int]

Definition Classes
Urls
final def internalServerError(docs: Documentation): Response[ServerError]

Definition Classes
Responses
final def invalidToClientErrors(invalid: Invalid): ClientErrors

Definition Classes
BuiltInErrors → Errors
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def joinDirectives[T1, T2](dir1: Directive1[T1], dir2: Directive1[T2])(implicit tupler: Tupler[T1, T2]): Directive1[Out]

Simpler alternative to Directive.&() method
Simpler alternative to Directive.&() method

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

Definition Classes
Urls
implicit def longSegment: Segment[Long]

Definition Classes
Urls
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def ok[A](entity: ResponseEntity[A], docs: Documentation): Response[A]

Definition Classes
Responses
def optHeader(name: String, docs: Documentation): RequestHeaders[Option[String]]

Definition Classes
EndpointsWithCustomErrors → Requests
implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]

Definition Classes
Urls → Urls
val path: Path[Unit]

Definition Classes
Urls
implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]

Definition Classes
Urls → Urls
final def post[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

Definition Classes
Requests
final def put[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

Definition Classes
Requests
def qs[A](name: String, docs: Documentation)(implicit param: QueryStringParam[A]): QueryString[A]

Definition Classes
Urls → Urls
implicit lazy val queryStringParamPartialInvFunctor: PartialInvariantFunctor[QueryStringParam]

Definition Classes
Urls → Urls
implicit lazy val queryStringPartialInvFunctor: PartialInvariantFunctor[QueryString]

Definition Classes
Urls → Urls
def remainingSegments(name: String, docs: Documentation): Path[String]

Definition Classes
Urls → Urls
implicit def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: QueryStringParam[A], factory: scala.collection.compat.Factory[A, CC[A]]): QueryStringParam[CC[A]]

Definition Classes
Urls → Urls
implicit lazy val reqEntityInvFunctor: InvariantFunctor[RequestEntity]

Definition Classes
EndpointsWithCustomErrors → Requests
implicit lazy val reqHeadersInvFunctor: InvariantFunctor[RequestHeaders]

Definition Classes
EndpointsWithCustomErrors → Requests
implicit lazy val reqHeadersSemigroupal: Semigroupal[RequestHeaders]

Definition Classes
EndpointsWithCustomErrors → Requests
def request[A, B, C, AB, Out](method: Method, url: Url[A], entity: RequestEntity[B] = emptyRequest, docs: Documentation = None, headers: RequestHeaders[C] = emptyHeaders)(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler.Aux[AB, C, Out]): Request[Out]

Definition Classes
EndpointsWithCustomErrors → Requests
def response[A](statusCode: StatusCode, entity: ResponseEntity[A], docs: Documentation = None): Response[A]

Definition Classes
EndpointsWithCustomErrors → Responses
implicit lazy val responseInvFunctor: InvariantFunctor[Response]

Definition Classes
EndpointsWithCustomErrors → Responses
def segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]

Definition Classes
Urls → Urls
implicit lazy val segmentPartialInvFunctor: PartialInvariantFunctor[Segment]

Definition Classes
Urls → Urls
lazy val serverErrorResponse: Response[ServerError]

Definition Classes
Errors
def serverErrorResponseEntity: ResponseEntity[Throwable]

Definition Classes
BuiltInErrors → BuiltInErrors → Errors
final def serverErrorToThrowable(serverError: ServerError): Throwable

Definition Classes
BuiltInErrors → Errors
def staticPathSegment(segment: String): Path[Unit]

Definition Classes
Urls → Urls
implicit lazy val stringQueryString: QueryStringParam[String]

Definition Classes
Urls → Urls
implicit def stringSegment: Segment[String]

Definition Classes
Urls → Urls
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def textRequest: RequestEntity[String]

Definition Classes
EndpointsWithCustomErrors → Requests
def textResponse: ResponseEntity[String]

Definition Classes
EndpointsWithCustomErrors → Responses
final def throwableToServerError(throwable: Throwable): ServerError

Definition Classes
BuiltInErrors → Errors
def toString(): String

Definition Classes
AnyRef → Any
def tryParseString[A](type: String)(parse: (String) ⇒ A): (String) ⇒ Validated[A]

Definition Classes
Urls
implicit lazy val urlPartialInvFunctor: PartialInvariantFunctor[Url]

Definition Classes
Urls → Urls
def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]

Definition Classes
Urls → Urls
implicit def uuidQueryString: QueryStringParam[UUID]

Definition Classes
Urls
implicit def uuidSegment: Segment[UUID]

Definition Classes
Urls
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation): Response[Option[A]]

Definition Classes
Responses

Related Doc: package server

trait Endpoints extends algebra.Endpoints with EndpointsWithCustomErrors with BuiltInErrors

Type Members

case class CallbackDocs extends Product with Serializable

type CallbacksDocs = Map[String, CallbackDocs]

type ClientErrors = Invalid

case class Endpoint[A, B](request: Request[A], response: Response[B]) extends Product with Serializable

case class EndpointDocs extends Product with Serializable

implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef

type Method = HttpMethod

implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef

trait Path[A] extends EndpointsWithCustomErrors.Url[A]

implicit class PathOps[A] extends AnyRef

trait QueryString[T] extends AnyRef

type QueryStringParam[T] = (String, Map[String, Seq[String]]) ⇒ Validated[T]

implicit class QueryStringSyntax[A] extends AnyRef

type Request[A] = Directive[(A)]

type RequestEntity[A] = Directive[(A)]

type RequestHeaders[A] = Directive[(A)]

type Response[A] = (A) ⇒ Route

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

implicit class ResponseSyntax[A] extends AnyRef

trait Segment[A] extends AnyRef

implicit class SemigroupalSyntax[A, F[_]] extends AnyRef

type ServerError = Throwable

type StatusCode = akka.http.scaladsl.model.StatusCode

trait Url[A] extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def Accepted: Success

def BadRequest: ClientError

def Created: Success

def Delete: HttpMethod

def Forbidden: ClientError

def Get: HttpMethod

def InternalServerError: akka.http.scaladsl.model.StatusCodes.ServerError

def NoContent: Success

def NotFound: ClientError

def NotImplemented: akka.http.scaladsl.model.StatusCodes.ServerError

def OK: Success

def Options: HttpMethod

def Patch: HttpMethod

def Post: HttpMethod

def Put: HttpMethod

def Unauthorized: ClientError

final def asInstanceOf[T0]: T0

final def badRequest(docs: Documentation): Response[ClientErrors]

implicit def booleanQueryString: QueryStringParam[Boolean]

def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]

def choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]

lazy val clientErrorsResponse: Response[ClientErrors]

def clientErrorsResponseEntity: ResponseEntity[Invalid]

final def clientErrorsToInvalid(clientErrors: ClientErrors): Invalid

def clone(): AnyRef

def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]

def convToDirective1(directive: Directive0): Directive1[Unit]

final def delete[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]

lazy val directive1InvFunctor: InvariantFunctor[Directive1]

implicit def doubleQueryString: QueryStringParam[Double]

implicit def doubleSegment: Segment[Double]

implicit def dummyPathToUrl[A](p: Path[A]): Url[A]

def emptyHeaders: RequestHeaders[Unit]

def emptyRequest: RequestEntity[Unit]

def emptyResponse: ResponseEntity[Unit]

def endpoint[A, B](request: Request[A], response: Response[B], docs: EndpointDocs = EndpointDocs()): Endpoint[A, B]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def get[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]

final def getClass(): Class[_]

def handleClientErrors(invalid: Invalid): StandardRoute

def handleServerError(throwable: Throwable): StandardRoute

def hashCode(): Int

def header(name: String, docs: Documentation): RequestHeaders[String]

implicit def intQueryString: QueryStringParam[Int]

implicit def intSegment: Segment[Int]

final def internalServerError(docs: Documentation): Response[ServerError]