JsonEntitiesFromCodec

Partial interpreter for endpoints.algebra.JsonEntitiesFromCodec that only fixes the JsonCodec[A] type to Play’s Format[A].

The jsonRequest and jsonResponse operations have to be implemented by a more specialized interpreter.

Typical usage:

/* shared MyDto.scala */

case class MyDto(i: Int, s: String)

object MyDto {
  import play.api.libs.{Format, Json}

  implicit val jsonFormat: Format[MyDto] = Json.format[MyDto]
}

/* shared endpoint definition */

trait MyEndpoints extends algebra.Endpoints with algebra.playjson.JsonEntitiesFromCodec {
  val myEndpoint = endpoint(get(path), jsonResponse[MyDto])
}

/* client MyEndpointsClient.scala */

object MyEndpointsClient extends MyEndpoints with xhr.JsonEntitiesFromCodec with xhr.faithful.Endpoints

MyEndpointsClient.myEndpoint().map(myDto => println(myDto.i))

/* server MyEndpointsServer.scala */

object MyEndpointsServer extends MyEndpoints with play.server.JsonEntitiesFromCodec {

  val routes = routesFromEndpoints(
    myEndpoint.implementedBy(_ => MyDto(42, "foo"))
  )

}

Source: JsonEntitiesFromCodec.scala

Linear Supertypes

algebra.JsonEntitiesFromCodec, JsonEntities, Endpoints, Responses, Requests, endpoints.SemigroupalSyntax, endpoints.InvariantFunctorSyntax, Methods, Urls, AnyRef, Any

Type Members

abstract type Endpoint[A, B]

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

Definition Classes
InvariantFunctorSyntax
type JsonCodec[A] = Format[A]

Definition Classes
JsonEntitiesFromCodec → JsonEntitiesFromCodec
type JsonRequest[A] = Codec[String, A]

Definition Classes
JsonEntitiesFromCodec → JsonEntities
type JsonResponse[A] = Codec[String, A]

Definition Classes
JsonEntitiesFromCodec → JsonEntities
abstract type Method

Definition Classes
Methods
abstract type Path[A] <: Url[A]

Definition Classes
Urls
implicit class PathOps[A] extends AnyRef

Definition Classes
Urls
abstract type QueryString[A]

Definition Classes
Urls
implicit class QueryStringOps[A] extends AnyRef

Definition Classes
Urls
abstract type QueryStringParam[A]

Definition Classes
Urls
abstract type Request[A]

Definition Classes
Requests
abstract type RequestEntity[A]

Definition Classes
Requests
abstract type RequestHeaders[A]

Definition Classes
Requests
abstract type Response[A]

Definition Classes
Responses
implicit class ResponseExtensions[A] extends AnyRef

Definition Classes
Responses
abstract type Segment[A]

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

Definition Classes
SemigroupalSyntax
abstract type Url[A]

Definition Classes
Urls

Abstract Value Members

abstract def Delete: Method

Definition Classes
Methods
abstract def Get: Method

Definition Classes
Methods
abstract def Options: Method

Definition Classes
Methods
abstract def Patch: Method

Definition Classes
Methods
abstract def Post: Method

Definition Classes
Methods
abstract def Put: Method

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

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

Definition Classes
Urls
abstract def emptyHeaders: RequestHeaders[Unit]

Definition Classes
Requests
abstract def emptyRequest: RequestEntity[Unit]

Definition Classes
Requests
abstract def emptyResponse(docs: Documentation): Response[Unit]

Definition Classes
Responses
abstract def endpoint[A, B](request: Request[A], response: Response[B], summary: Documentation, description: Documentation, tags: List[String]): Endpoint[A, B]

Definition Classes
Endpoints
abstract def header(name: String, docs: Documentation): RequestHeaders[String]

Definition Classes
Requests
implicit abstract def intSegment: Segment[Int]

Definition Classes
Urls
abstract def jsonRequest[A](docs: Documentation)(implicit arg0: JsonRequest[A]): RequestEntity[A]

Definition Classes
JsonEntities
abstract def jsonResponse[A](docs: Documentation)(implicit arg0: JsonResponse[A]): Response[A]

Definition Classes
JsonEntities
implicit abstract def longSegment: Segment[Long]

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

Definition Classes
Requests
implicit abstract def optionalQueryStringParam[A](implicit arg0: QueryStringParam[A]): QueryStringParam[Option[A]]

Definition Classes
Urls
abstract def qs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[A]

Definition Classes
Urls
abstract def refineQueryStringParam[A, B](pa: QueryStringParam[A])(f: (A) ⇒ Option[B])(g: (B) ⇒ A): QueryStringParam[B]

Definition Classes
Urls
abstract def refineSegment[A, B](sa: Segment[A])(f: (A) ⇒ Option[B])(g: (B) ⇒ A): Segment[B]

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

Definition Classes
Urls
implicit abstract def reqEntityInvFunctor: InvariantFunctor[RequestEntity]

Definition Classes
Requests
implicit abstract def reqHeadersInvFunctor: InvariantFunctor[RequestHeaders]

Definition Classes
Requests
implicit abstract def reqHeadersSemigroupal: Semigroupal[RequestHeaders]

Definition Classes
Requests
abstract def request[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](method: Method, url: Url[UrlP], entity: RequestEntity[BodyP], headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

Definition Classes
Requests
abstract def segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]

Definition Classes
Urls
abstract def staticPathSegment(segment: String): Path[Unit]

Definition Classes
Urls
implicit abstract def stringQueryString: QueryStringParam[String]

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

Definition Classes
Urls
abstract def textRequest(docs: Documentation): RequestEntity[String]

Definition Classes
Requests
abstract def textResponse(docs: Documentation): Response[String]

Definition Classes
Responses
implicit abstract def urlInvFunctor: InvariantFunctor[Url]

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

Definition Classes
Urls
abstract def wheneverFound[A](response: Response[A], notFoundDocs: Documentation): Response[Option[A]]

Definition Classes
Responses

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
final def asInstanceOf[T0]: T0

Definition Classes
Any
implicit def booleanQueryString: QueryStringParam[Boolean]

Definition Classes
Urls
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def delete[UrlP, HeadersP, Out](url: Url[UrlP], 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 dummyPathToUrl[A](p: Path[A]): Url[A]

Definition Classes
Urls
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], headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]

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

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
implicit def intQueryString: QueryStringParam[Int]

Definition Classes
Urls
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
implicit def jsonCodec[A](implicit arg0: Format[A]): Codec[String, A]

Definition Classes
JsonEntitiesFromCodec → JsonEntitiesFromCodec
implicit def longQueryString: QueryStringParam[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
val path: Path[Unit]

Definition Classes
Urls
final def post[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], 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], headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

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

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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( ... )

Related Doc: package playjson

trait JsonEntitiesFromCodec extends algebra.JsonEntitiesFromCodec

Type Members

abstract type Endpoint[A, B]

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

type JsonCodec[A] = Format[A]

type JsonRequest[A] = Codec[String, A]

type JsonResponse[A] = Codec[String, A]

abstract type Method

abstract type Path[A] <: Url[A]

implicit class PathOps[A] extends AnyRef

abstract type QueryString[A]

implicit class QueryStringOps[A] extends AnyRef

abstract type QueryStringParam[A]

abstract type Request[A]

abstract type RequestEntity[A]

abstract type RequestHeaders[A]

abstract type Response[A]

implicit class ResponseExtensions[A] extends AnyRef

abstract type Segment[A]

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

abstract type Url[A]

Abstract Value Members

abstract def Delete: Method

abstract def Get: Method

abstract def Options: Method

abstract def Patch: Method

abstract def Post: Method

abstract def Put: Method

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

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

abstract def emptyHeaders: RequestHeaders[Unit]

abstract def emptyRequest: RequestEntity[Unit]

abstract def emptyResponse(docs: Documentation): Response[Unit]

abstract def endpoint[A, B](request: Request[A], response: Response[B], summary: Documentation, description: Documentation, tags: List[String]): Endpoint[A, B]

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

implicit abstract def intSegment: Segment[Int]

abstract def jsonRequest[A](docs: Documentation)(implicit arg0: JsonRequest[A]): RequestEntity[A]

abstract def jsonResponse[A](docs: Documentation)(implicit arg0: JsonResponse[A]): Response[A]

implicit abstract def longSegment: Segment[Long]

abstract def optHeader(name: String, docs: Documentation): RequestHeaders[Option[String]]

implicit abstract def optionalQueryStringParam[A](implicit arg0: QueryStringParam[A]): QueryStringParam[Option[A]]

abstract def qs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[A]

abstract def refineQueryStringParam[A, B](pa: QueryStringParam[A])(f: (A) ⇒ Option[B])(g: (B) ⇒ A): QueryStringParam[B]

abstract def refineSegment[A, B](sa: Segment[A])(f: (A) ⇒ Option[B])(g: (B) ⇒ A): Segment[B]

implicit abstract def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit arg0: QueryStringParam[A], factory: scala.collection.compat.Factory[A, CC[A]]): QueryStringParam[CC[A]]

implicit abstract def reqEntityInvFunctor: InvariantFunctor[RequestEntity]

implicit abstract def reqHeadersInvFunctor: InvariantFunctor[RequestHeaders]

implicit abstract def reqHeadersSemigroupal: Semigroupal[RequestHeaders]

abstract def request[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](method: Method, url: Url[UrlP], entity: RequestEntity[BodyP], headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

abstract def segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]

abstract def staticPathSegment(segment: String): Path[Unit]

implicit abstract def stringQueryString: QueryStringParam[String]

implicit abstract def stringSegment: Segment[String]

abstract def textRequest(docs: Documentation): RequestEntity[String]

abstract def textResponse(docs: Documentation): Response[String]

implicit abstract def urlInvFunctor: InvariantFunctor[Url]

abstract def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]

abstract def wheneverFound[A](response: Response[A], notFoundDocs: Documentation): Response[Option[A]]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

implicit def booleanQueryString: QueryStringParam[Boolean]

def clone(): AnyRef

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

implicit def doubleQueryString: QueryStringParam[Double]

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

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

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

final def getClass(): Class[_]

def hashCode(): Int

implicit def intQueryString: QueryStringParam[Int]

final def isInstanceOf[T0]: Boolean

implicit def jsonCodec[A](implicit arg0: Format[A]): Codec[String, A]

implicit def longQueryString: QueryStringParam[Long]