trait JsonEntitiesFromCodec extends Endpoints with algebra.JsonEntitiesFromCodec
Interpreter for endpoints.algebra.JsonEntitiesFromCodec that decodes JSON requests and encodes JSON responses using Akka HTTP.
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- JsonEntitiesFromCodec
- JsonEntitiesFromCodec
- JsonEntities
- Endpoints
- Methods
- Urls
- StatusCodes
- Endpoints
- Responses
- StatusCodes
- Requests
- SemigroupalSyntax
- Methods
- Urls
- PartialInvariantFunctorSyntax
- InvariantFunctorSyntax
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- All
Type Members
- case class Endpoint[A, B](request: Request[A], response: Response[B]) extends Product with Serializable
- Definition Classes
- Endpoints
- implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef
- Definition Classes
- InvariantFunctorSyntax
- abstract type JsonCodec[A]
- Definition Classes
- JsonEntitiesFromCodec
- type JsonRequest[A] = Codec[String, A]
- Definition Classes
- JsonEntitiesFromCodec → JsonEntities
- type JsonResponse[A] = Codec[String, A]
- Definition Classes
- JsonEntitiesFromCodec → JsonEntities
- type Method = HttpMethod
- Definition Classes
- Methods → Methods
- implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
- Definition Classes
- PartialInvariantFunctorSyntax
- implicit class PathOps[A] extends AnyRef
- Definition Classes
- Urls
- type QueryStringParam[T] = (String, Map[String, Seq[String]]) => Validated[T]
<invalid inheritdoc annotation>
<invalid inheritdoc annotation>
Given a parameter name and a query string content, returns a decoded parameter value of type
T, orNoneif decoding failed- Definition Classes
- Urls → Urls
- implicit class QueryStringSyntax[A] extends AnyRef
- Definition Classes
- Urls
- type Request[A] = Directive[(A)]
- Definition Classes
- Endpoints → Requests
- type RequestEntity[A] = Directive[(A)]
- Definition Classes
- Endpoints → Requests
- type RequestHeaders[A] = Directive[(A)]
- Definition Classes
- Endpoints → Requests
- type Response[A] = (A) => Route
- Definition Classes
- Endpoints → Responses
- type ResponseEntity[A] = Marshaller[A, MessageEntity]
- Definition Classes
- Endpoints → Responses
- implicit class ResponseSyntax[A] extends AnyRef
- Definition Classes
- Responses
- implicit class SemigroupalSyntax[A, F[_]] extends AnyRef
- Definition Classes
- SemigroupalSyntax
- type StatusCode = akka.http.scaladsl.model.StatusCode
- Definition Classes
- StatusCodes → StatusCodes
- trait Path[A] extends Url[A]
- Definition Classes
- Urls
- trait QueryString[T] extends AnyRef
- Definition Classes
- Urls
- trait Segment[A] extends AnyRef
- Definition Classes
- Urls
- trait Url[A] extends AnyRef
- Definition Classes
- Urls
Abstract Value Members
Concrete 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: ServerError
- Definition Classes
- StatusCodes → StatusCodes
- def NoContent: Success
- Definition Classes
- StatusCodes → StatusCodes
- def NotFound: ClientError
- 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[A](entity: ResponseEntity[A], docs: Documentation): Response[A]
- 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
- Endpoints → Responses
- def clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- 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
- Endpoints
- 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
- Endpoints → Requests
- def emptyRequest: RequestEntity[Unit]
- Definition Classes
- Endpoints → Requests
- def emptyResponse: ResponseEntity[Unit]
- Definition Classes
- Endpoints → Responses
- def endpoint[A, B](request: Request[A], response: Response[B], summary: Documentation = None, description: Documentation = None, tags: List[String] = Nil): Endpoint[A, B]
- Definition Classes
- Endpoints → Endpoints
- 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, 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() @HotSpotIntrinsicCandidate()
- 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 default implementation is to return a route that completes with a Bad Request (400) response containing the error messages as a JSON array of string values.
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 default implementation is to return a route that completes with an Internal Server Error (500) response containing the error messages as a JSON array of string values.
This method can be overridden to customize the error reporting logic.
- Definition Classes
- Endpoints
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def header(name: String, docs: Documentation): RequestHeaders[String]
- Definition Classes
- Endpoints → Requests
- implicit def intQueryString: QueryStringParam[Int]
- Definition Classes
- Urls
- implicit def intSegment: Segment[Int]
- Definition Classes
- Urls
- 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
- def jsonRequest[A](implicit codec: Codec[String, A]): RequestEntity[A]
- Definition Classes
- JsonEntitiesFromCodec → JsonEntities
- def jsonResponse[A](implicit codec: Codec[String, A]): ResponseEntity[A]
- Definition Classes
- JsonEntitiesFromCodec → JsonEntities
- 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
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- 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
- Endpoints → 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: Factory[A, CC[A]]): QueryStringParam[CC[A]]
- Definition Classes
- Urls → Urls
- implicit lazy val reqEntityInvFunctor: InvariantFunctor[RequestEntity]
- Definition Classes
- Endpoints → Requests
- implicit lazy val reqHeadersInvFunctor: InvariantFunctor[RequestHeaders]
- Definition Classes
- Endpoints → Requests
- implicit lazy val reqHeadersSemigroupal: Semigroupal[RequestHeaders]
- Definition Classes
- Endpoints → 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
- Endpoints → Requests
- def response[A](statusCode: StatusCode, entity: ResponseEntity[A], docs: Documentation = None): Response[A]
- Definition Classes
- Endpoints → Responses
- implicit lazy val responseInvFunctor: InvariantFunctor[Response]
- Definition Classes
- Endpoints → 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
- 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
- Endpoints → Requests
- def textResponse: ResponseEntity[String]
- Definition Classes
- Endpoints → Responses
- 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(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 wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation): Response[Option[A]]
- Definition Classes
- Responses