trait Endpoints extends algebra.Endpoints with EndpointsWithCustomErrors with BuiltInErrors
Ordering
- Alphabetic
- By Inheritance
Inherited
- Endpoints
- BuiltInErrors
- EndpointsWithCustomErrors
- Responses
- StatusCodes
- Requests
- Methods
- Urls
- Endpoints
- BuiltInErrors
- 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
- final class CallbackDocs extends Serializable
- Definition Classes
- EndpointsWithCustomErrors
- type CallbacksDocs = Map[String, CallbackDocs]
- Definition Classes
- EndpointsWithCustomErrors
- type ClientErrors = Invalid
- Definition Classes
- BuiltInErrors → Errors
- final class EndpointDocs extends Serializable
- Definition Classes
- EndpointsWithCustomErrors
- implicit final class EndpointSyntax[A, B] extends AnyRef
- Definition Classes
- EndpointsWithCustomErrors
- implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef
- Definition Classes
- InvariantFunctorSyntax
- type Method = String
- Definition Classes
- Methods → Methods
- implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
- Definition Classes
- PartialInvariantFunctorSyntax
- implicit class PathOps[A] extends AnyRef
- Definition Classes
- Urls
- type QueryString[A] = (A) => Seq[(String, String)]
- Definition Classes
- Urls → Urls
- type QueryStringParam[A] = (A) => List[String]
- Definition Classes
- Urls → Urls
- implicit class QueryStringSyntax[A] extends AnyRef
- Definition Classes
- Urls
- type Request[A] = (A) => HttpRequest
- Definition Classes
- Requests → Requests
- type RequestEntity[A] = (A, HttpRequest) => HttpRequest
- Definition Classes
- Requests → Requests
- implicit class RequestEntitySyntax[A] extends AnyRef
- Definition Classes
- Requests
- type RequestHeaders[A] = (A) => Seq[(String, String)]
- Definition Classes
- Requests → Requests
- implicit final class RequestSyntax[A] extends AnyRef
- Definition Classes
- Requests
- type Response[A] = (HttpResponse[String]) => Option[ResponseEntity[A]]
- Definition Classes
- Responses → Responses
- type ResponseEntity[A] = (String) => Either[Throwable, A]
- Definition Classes
- Responses → Responses
- type ResponseHeaders[A] = (Map[String, Seq[String]]) => Validated[A]
- Definition Classes
- Responses → Responses
- implicit class ResponseSyntax[A] extends AnyRef
- Definition Classes
- Responses
- type Segment[A] = (A) => String
- Definition Classes
- Urls → Urls
- implicit class SemigroupalSyntax[A, F[_]] extends AnyRef
- Definition Classes
- SemigroupalSyntax
- type ServerError = Throwable
- Definition Classes
- BuiltInErrors → Errors
- type StatusCode = Int
- Definition Classes
- StatusCodes → StatusCodes
- type WithDefault[A] = Option[A]
- Definition Classes
- Urls → Urls
- case class Endpoint[Req, Resp](request: EndpointsWithCustomErrors.Request[Req], response: EndpointsWithCustomErrors.Response[Resp]) extends Product with Serializable
- Definition Classes
- EndpointsWithCustomErrors
- case class Path[A](toStr: (A) => String) extends Url[A] with Product with Serializable
- Definition Classes
- Urls
- class Url[A] extends AnyRef
- Definition Classes
- Urls
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Endpoints, B)
- 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
- def Conflict: Int
- Definition Classes
- StatusCodes → StatusCodes
- def Created: Int
- Definition Classes
- StatusCodes → StatusCodes
- def Delete: Method
- Definition Classes
- Methods → Methods
- def ExpectationFailed: Int
- Definition Classes
- StatusCodes → StatusCodes
- def FailedDependency: Int
- Definition Classes
- StatusCodes → StatusCodes
- def Forbidden: Int
- Definition Classes
- StatusCodes → StatusCodes
- def Get: Method
- Definition Classes
- Methods → Methods
- def Gone: Int
- Definition Classes
- StatusCodes → StatusCodes
- def IMUsed: Int
- Definition Classes
- StatusCodes → StatusCodes
- def InternalServerError: Int
- Definition Classes
- StatusCodes → StatusCodes
- 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 Options: Method
- Definition Classes
- Methods → Methods
- def PartialContent: Int
- Definition Classes
- StatusCodes → StatusCodes
- def Patch: Method
- Definition Classes
- Methods → Methods
- def PayloadTooLarge: Int
- Definition Classes
- StatusCodes → StatusCodes
- def PaymentRequired: Int
- Definition Classes
- StatusCodes → StatusCodes
- def Post: Method
- Definition Classes
- Methods → Methods
- def PreconditionFailed: Int
- Definition Classes
- StatusCodes → StatusCodes
- def PreconditionRequired: Int
- Definition Classes
- StatusCodes → StatusCodes
- def ProxyAuthenticationRequired: Int
- Definition Classes
- StatusCodes → StatusCodes
- def Put: Method
- Definition Classes
- Methods → Methods
- 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 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]
- Definition Classes
- Requests → Requests
- def addRequestQueryString[A, Q](request: Request[A], qs: QueryString[Q])(implicit tupler: Tupler[A, Q]): Request[Out]
- Definition Classes
- Requests → Requests
- def addResponseHeaders[A, H](response: Response[A], headers: ResponseHeaders[H])(implicit tupler: Tupler[A, H]): Response[Out]
- Definition Classes
- Responses → Responses
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- final def badRequest[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ClientErrors, A, R]): Response[R]
- 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 choiceRequestEntity[A, B](requestEntityA: RequestEntity[A], requestEntityB: RequestEntity[B]): RequestEntity[Either[A, B]]
- Definition Classes
- Requests → Requests
- def choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]
- Definition Classes
- Responses → 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[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]
- Definition Classes
- Urls → 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
- implicit def doubleQueryString: QueryStringParam[Double]
- Definition Classes
- Urls
- implicit def doubleSegment: Segment[Double]
- Definition Classes
- Urls
- def emptyRequest: RequestEntity[Unit]
- Definition Classes
- Requests → Requests
- def emptyRequestHeaders: RequestHeaders[Unit]
- Definition Classes
- Requests → Requests
- def emptyResponse: ResponseEntity[Unit]
- Definition Classes
- Responses → Responses
- def emptyResponseHeaders: ResponseHeaders[Unit]
- Definition Classes
- Responses → Responses
- def endpoint[A, B](request: Request[A], response: Response[B], docs: EndpointDocs = EndpointDocs()): Endpoint[A, B]
- Definition Classes
- EndpointsWithCustomErrors → EndpointsWithCustomErrors
- def ensuring(cond: (Endpoints) => Boolean, msg: => Any): Endpoints
- def ensuring(cond: (Endpoints) => Boolean): Endpoints
- def ensuring(cond: Boolean, msg: => Any): Endpoints
- def ensuring(cond: Boolean): Endpoints
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[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[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- implicit def intQueryString: QueryStringParam[Int]
- Definition Classes
- Urls
- implicit def intSegment: Segment[Int]
- Definition Classes
- Urls
- final def internalServerError[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ServerError, A, R]): Response[R]
- Definition Classes
- Responses
- final def invalidToClientErrors(invalid: Invalid): ClientErrors
- Definition Classes
- BuiltInErrors → Errors
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- implicit def longQueryString: QueryStringParam[Long]
- Definition Classes
- Urls
- implicit def longSegment: Segment[Long]
- Definition Classes
- Urls
- def mapEndpointDocs[A, B](currentEndpoint: Endpoint[A, B], func: (EndpointDocs) => EndpointDocs): Endpoint[A, B]
- Definition Classes
- EndpointsWithCustomErrors → EndpointsWithCustomErrors
- def mapEndpointRequest[A, B, C](currentEndpoint: Endpoint[A, B], func: (Request[A]) => Request[C]): Endpoint[C, B]
- Definition Classes
- EndpointsWithCustomErrors → EndpointsWithCustomErrors
- def mapEndpointResponse[A, B, C](currentEndpoint: Endpoint[A, B], func: (Response[B]) => Response[C]): Endpoint[A, C]
- Definition Classes
- EndpointsWithCustomErrors → EndpointsWithCustomErrors
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def ok[A, B, R](entity: ResponseEntity[A], docs: Documentation, headers: ResponseHeaders[B])(implicit tupler: Tupler.Aux[A, B, R]): Response[R]
- Definition Classes
- Responses
- def optQsWithDefault[A](name: String, default: A, docs: Documentation = None)(implicit value: QueryStringParam[A]): QueryString[WithDefault[A]]
- Definition Classes
- Urls → Urls
- def optRequestHeader(name: String, docs: Documentation): (Option[String]) => Seq[(String, String)]
- Definition Classes
- Requests → Requests
- def optResponseHeader(name: String, docs: Documentation = None): ResponseHeaders[Option[String]]
- Definition Classes
- Responses → Responses
- implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]
- Definition Classes
- Urls → Urls
- final def patch[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
- 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
- def protocol: String
- Definition Classes
- Urls
- 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 value: QueryStringParam[A]): QueryString[A]
- Definition Classes
- Urls → Urls
- implicit lazy val queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]
- Definition Classes
- Urls → Urls
- implicit lazy val queryStringPartialInvariantFunctor: 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: Factory[A, CC[A]]): QueryStringParam[CC[A]]
- Definition Classes
- Urls → Urls
- def request[U, E, H, UE, Out](method: Method, url: Url[U], entity: RequestEntity[E] = emptyRequest, docs: Documentation = None, headers: RequestHeaders[H] = emptyRequestHeaders)(implicit tuplerUE: Tupler.Aux[U, E, UE], tuplerUEH: Tupler.Aux[UE, H, Out]): Request[Out]
- Definition Classes
- Requests → Requests
- implicit def requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]
- Definition Classes
- Requests → Requests
- def requestHeader(name: String, docs: Documentation): (String) => Seq[(String, String)]
- Definition Classes
- Requests → Requests
- implicit def requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]
- Definition Classes
- Requests → Requests
- implicit def requestHeadersSemigroupal: Semigroupal[RequestHeaders]
- Definition Classes
- Requests → Requests
- implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]
- Definition Classes
- Requests → Requests
- 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]
- Definition Classes
- Responses → Responses
- implicit def responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
- Definition Classes
- Responses → Responses
- def responseHeader(name: String, docs: Documentation = None): ResponseHeaders[String]
- Definition Classes
- Responses → Responses
- implicit def responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]
- Definition Classes
- Responses → Responses
- implicit def responseHeadersSemigroupal: Semigroupal[ResponseHeaders]
- Definition Classes
- Responses → Responses
- implicit lazy val responseInvariantFunctor: InvariantFunctor[Response]
- Definition Classes
- Responses → Responses
- def segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]
- Definition Classes
- Urls → Urls
- implicit lazy val segmentPartialInvariantFunctor: 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 def 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: (String, HttpRequest) => HttpRequest
- Definition Classes
- Requests → Requests
- def textResponse: ResponseEntity[String]
- Definition Classes
- Responses → Responses
- final def throwableToServerError(throwable: Throwable): ServerError
- Definition Classes
- BuiltInErrors → Errors
- def toString(): String
- Definition Classes
- AnyRef → Any
- implicit lazy val urlPartialInvariantFunctor: PartialInvariantFunctor[Url]
- Definition Classes
- Urls → Urls
- 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
- 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(classOf[java.lang.InterruptedException])
- 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]) @native()
- final def wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation): Response[Option[A]]
- Definition Classes
- Responses
- object EndpointDocs extends Serializable
- Definition Classes
- EndpointsWithCustomErrors
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from Endpoints toStringFormat[Endpoints] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- def →[B](y: B): (Endpoints, B)
- Implicit
- This member is added by an implicit conversion from Endpoints toArrowAssoc[Endpoints] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->
instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.