JsonEntities

Type Members

implicit final class ApplicativeMapSyntax[F[_], A] extends AnyRef

Definition Classes
Urls
case class Endpoint[A, B] extends Product with Serializable

Definition Classes
Endpoints
case class EndpointWithHandler[A, B] extends ToPlayHandler with Product with Serializable

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

Definition Classes
InvariantFunctorSyntax
type JsonRequest[A] = Decoder[A]

Decode requests using circe’s io.circe.Decoder
Decode requests using circe’s io.circe.Decoder

Definition Classes
JsonEntities → JsonEntities
type JsonResponse[A] = Encoder[A]

Encode responses using circe’s io.circe.Encoder
Encode responses using circe’s io.circe.Encoder

Definition Classes
JsonEntities → JsonEntities
case class Method extends Product with Serializable

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

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

Definition Classes
Urls
implicit class PathOps[A] extends AnyRef

Definition Classes
Urls
trait QueryString[A] extends AnyRef

Definition Classes
Urls
implicit class QueryStringOps[A] extends AnyRef

Definition Classes
Urls
trait QueryStringParam[A] extends AnyRef

Definition Classes
Urls
trait Request[A] extends AnyRef

Definition Classes
Endpoints
type RequestEntity[A] = BodyParser[A]

Definition Classes
Endpoints → Requests
type RequestExtractor[A] = (RequestHeader) ⇒ Option[A]

Definition Classes
Urls
type RequestHeaders[A] = (Headers) ⇒ Either[Result, A]

Definition Classes
Endpoints → Requests
type Response[A] = (A) ⇒ Result

Definition Classes
Endpoints → Responses
implicit class ResponseExtensions[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 StatusCode = play.api.mvc.Results.Status

Definition Classes
StatusCodes → StatusCodes
trait ToPlayHandler extends AnyRef

Definition Classes
Endpoints
trait Url[A] extends AnyRef

Definition Classes
Urls
trait UrlAndHeaders[A] extends AnyRef

Definition Classes
Endpoints

Abstract Value Members

abstract val playComponents: PlayComponents

Attributes
protected
Definition Classes
Endpoints

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 BadRequest: play.api.mvc.Results.Status

Definition Classes
StatusCodes → StatusCodes
def Delete: Method

Definition Classes
Methods → Methods
implicit def EmptyEndpointToPlayHandler[A, B](endpoint: Endpoint[A, B])(implicit ev: =:=[Unit, B]): ToPlayHandler

Definition Classes
Endpoints
def Get: Method

Definition Classes
Methods → Methods
def NotFound: play.api.mvc.Results.Status

Definition Classes
StatusCodes → StatusCodes
def OK: play.api.mvc.Results.Status

Definition Classes
StatusCodes → StatusCodes
def Options: Method

Definition Classes
Methods → Methods
def Patch: Method

Definition Classes
Methods → Methods
def Post: Method

Definition Classes
Methods → Methods
def Put: Method

Definition Classes
Methods → Methods
def Unauthorized: play.api.mvc.Results.Status

Definition Classes
StatusCodes → StatusCodes
implicit lazy val applicativeRequestExtractor: Applicative[RequestExtractor]

Definition Classes
Urls
final def asInstanceOf[T0]: T0

Definition Classes
Any
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 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
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 doubleSegment: Segment[Double]

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

Definition Classes
Urls
lazy val emptyHeaders: RequestHeaders[Unit]

Definition Classes
Endpoints → Requests
lazy val emptyRequest: BodyParser[Unit]

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

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

Definition Classes
Endpoints → Endpoints
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] )
implicit lazy val functorRequestExtractor: Functor[RequestExtractor]

Definition Classes
Urls
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
def header(name: String, docs: Option[String]): (Headers) ⇒ Either[Result, String]

Definition Classes
Endpoints → Requests
lazy val htmlResponse: Response[Html]

Definition Classes
Endpoints
implicit def intQueryString: QueryStringParam[Int]

Definition Classes
Urls
implicit def intSegment: Segment[Int]

Definition Classes
Urls
implicit lazy val invariantFunctorRequest: play.api.libs.functional.InvariantFunctor[Request]

Definition Classes
Endpoints
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def jsonRequest[A](docs: Documentation)(implicit arg0: Decoder[A]): RequestEntity[A]

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

Definition Classes
JsonEntities → 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
final def notifyAll(): Unit

Definition Classes
AnyRef
def optHeader(name: String, docs: Option[String]): (Headers) ⇒ Either[Result, 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], 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
def qs[A](name: String, docs: Documentation)(implicit value: 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 redirect[A](other: ⇒ Endpoint[A, _])(args: A): Response[Unit]

Definition Classes
Endpoints
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 def 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], headers: RequestHeaders[C])(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler.Aux[AB, C, Out]): Request[Out]

Definition Classes
Endpoints → Requests
def routesFromEndpoints(endpoints: ToPlayHandler*): PartialFunction[RequestHeader, Handler]

Definition Classes
Endpoints
def segment[A](name: String, docs: Documentation)(implicit A: 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(docs: Documentation): BodyParser[String]

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

Definition Classes
Endpoints → Responses
def toString(): String

Definition Classes
AnyRef → Any
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
val utf8Name: String

Definition Classes
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( ... )
def wheneverFound[A](response: Response[A], notFoundDocs: Documentation): Response[Option[A]]

Definition Classes
Endpoints → Responses

Related Doc: package circe

trait JsonEntities extends Endpoints with algebra.JsonEntities

Type Members

implicit final class ApplicativeMapSyntax[F[_], A] extends AnyRef

case class Endpoint[A, B] extends Product with Serializable

case class EndpointWithHandler[A, B] extends ToPlayHandler with Product with Serializable

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

type JsonRequest[A] = Decoder[A]

type JsonResponse[A] = Encoder[A]

case class Method extends Product with Serializable

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

trait Path[A] extends Url[A]

implicit class PathOps[A] extends AnyRef

trait QueryString[A] extends AnyRef

implicit class QueryStringOps[A] extends AnyRef

trait QueryStringParam[A] extends AnyRef

trait Request[A] extends AnyRef

type RequestEntity[A] = BodyParser[A]

type RequestExtractor[A] = (RequestHeader) ⇒ Option[A]

type RequestHeaders[A] = (Headers) ⇒ Either[Result, A]

type Response[A] = (A) ⇒ Result

implicit class ResponseExtensions[A] extends AnyRef

trait Segment[A] extends AnyRef

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

type StatusCode = play.api.mvc.Results.Status

trait ToPlayHandler extends AnyRef

trait Url[A] extends AnyRef

trait UrlAndHeaders[A] extends AnyRef

Abstract Value Members

abstract val playComponents: PlayComponents

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def BadRequest: play.api.mvc.Results.Status

def Delete: Method

implicit def EmptyEndpointToPlayHandler[A, B](endpoint: Endpoint[A, B])(implicit ev: =:=[Unit, B]): ToPlayHandler

def Get: Method

def NotFound: play.api.mvc.Results.Status

def OK: play.api.mvc.Results.Status

def Options: Method

def Patch: Method

def Post: Method

def Put: Method

def Unauthorized: play.api.mvc.Results.Status

implicit lazy val applicativeRequestExtractor: Applicative[RequestExtractor]

final def asInstanceOf[T0]: T0

implicit def booleanQueryString: QueryStringParam[Boolean]

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

def clone(): AnyRef

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

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 doubleSegment: Segment[Double]

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

lazy val emptyHeaders: RequestHeaders[Unit]

lazy val emptyRequest: BodyParser[Unit]

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

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

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

implicit lazy val functorRequestExtractor: Functor[RequestExtractor]

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

def header(name: String, docs: Option[String]): (Headers) ⇒ Either[Result, String]

lazy val htmlResponse: Response[Html]

implicit def intQueryString: QueryStringParam[Int]

implicit def intSegment: Segment[Int]

implicit lazy val invariantFunctorRequest: play.api.libs.functional.InvariantFunctor[Request]

final def isInstanceOf[T0]: Boolean

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

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

implicit def longQueryString: QueryStringParam[Long]

implicit def longSegment: Segment[Long]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit