Packages

trait JsonEntities extends EndpointsWithCustomErrors with algebra.JsonEntities

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JsonEntities
  2. JsonEntities
  3. EndpointsWithCustomErrors
  4. StatusCodes
  5. Methods
  6. Urls
  7. EndpointsWithCustomErrors
  8. Errors
  9. Responses
  10. StatusCodes
  11. Requests
  12. SemigroupalSyntax
  13. Methods
  14. Urls
  15. PartialInvariantFunctorSyntax
  16. InvariantFunctorSyntax
  17. AnyRef
  18. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. implicit final class ApplicativeMapSyntax[F[_], A] extends AnyRef
    Definition Classes
    Urls
  2. final class CallbackDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  3. type CallbacksDocs = Map[String, CallbackDocs]
    Definition Classes
    EndpointsWithCustomErrors
  4. abstract type ClientErrors
    Definition Classes
    Errors
  5. case class Endpoint[A, B] extends Product with Serializable
    Definition Classes
    EndpointsWithCustomErrors
  6. final class EndpointDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  7. case class EndpointWithHandler[A, B] extends ToPlayHandler with Product with Serializable
    Definition Classes
    EndpointsWithCustomErrors
  8. implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    InvariantFunctorSyntax
  9. type JsonRequest[A] = io.circe.Decoder[A]

    Decode requests using circe’s io.circe.Decoder

    Decode requests using circe’s io.circe.Decoder

    Definition Classes
    JsonEntities → JsonEntities
  10. type JsonResponse[A] = io.circe.Encoder[A]

    Encode responses using circe’s io.circe.Encoder

    Encode responses using circe’s io.circe.Encoder

    Definition Classes
    JsonEntities → JsonEntities
  11. case class Method extends Product with Serializable
    Definition Classes
    Methods
  12. implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    PartialInvariantFunctorSyntax
  13. trait Path[A] extends EndpointsWithCustomErrors.Url[A]
    Definition Classes
    Urls
  14. implicit class PathOps[A] extends AnyRef
    Definition Classes
    Urls
  15. trait QueryString[A] extends AnyRef
    Definition Classes
    Urls
  16. trait QueryStringParam[A] extends AnyRef
    Definition Classes
    Urls
  17. implicit class QueryStringSyntax[A] extends AnyRef
    Definition Classes
    Urls
  18. trait Request[A] extends AnyRef
    Definition Classes
    EndpointsWithCustomErrors
  19. type RequestEntity[A] = (RequestHeader) => Option[BodyParser[A]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  20. implicit class RequestEntitySyntax[A] extends AnyRef
    Definition Classes
    Requests
  21. type RequestExtractor[A] = (RequestHeader) => Option[A]
    Definition Classes
    Urls
  22. type RequestHeaders[A] = (Headers) => Validated[A]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  23. type Response[A] = (A) => Result
    Definition Classes
    EndpointsWithCustomErrors → Responses
  24. type ResponseEntity[A] = (A) => HttpEntity
    Definition Classes
    EndpointsWithCustomErrors → Responses
  25. type ResponseHeaders[A] = (A) => Seq[(String, String)]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  26. implicit class ResponseSyntax[A] extends AnyRef
    Definition Classes
    Responses
  27. trait Segment[A] extends AnyRef
    Definition Classes
    Urls
  28. implicit class SemigroupalSyntax[A, F[_]] extends AnyRef
    Definition Classes
    SemigroupalSyntax
  29. abstract type ServerError
    Definition Classes
    Errors
  30. type StatusCode = play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  31. trait ToPlayHandler extends AnyRef
    Definition Classes
    EndpointsWithCustomErrors
  32. trait Url[A] extends AnyRef
    Definition Classes
    Urls
  33. trait UrlAndHeaders[A] extends AnyRef
    Definition Classes
    EndpointsWithCustomErrors

Abstract Value Members

  1. abstract def clientErrorsResponseEntity: ResponseEntity[ClientErrors]
    Definition Classes
    Errors
  2. abstract def clientErrorsToInvalid(clientErrors: ClientErrors): Invalid
    Definition Classes
    Errors
  3. abstract def invalidToClientErrors(invalid: Invalid): ClientErrors
    Definition Classes
    Errors
  4. abstract val playComponents: PlayComponents
    Definition Classes
    EndpointsWithCustomErrors
  5. abstract def serverErrorResponseEntity: ResponseEntity[ServerError]
    Definition Classes
    Errors
  6. abstract def serverErrorToThrowable(serverError: ServerError): Throwable
    Definition Classes
    Errors
  7. abstract def throwableToServerError(throwable: Throwable): ServerError
    Definition Classes
    Errors

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def Accepted: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  5. def BadRequest: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  6. def Created: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  7. def Delete: Method
    Definition Classes
    Methods → Methods
  8. implicit def EmptyEndpointToPlayHandler[A, B](endpoint: Endpoint[A, B])(implicit ev: =:=[Unit, B]): ToPlayHandler
    Definition Classes
    EndpointsWithCustomErrors
  9. def Forbidden: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  10. def Get: Method
    Definition Classes
    Methods → Methods
  11. def InternalServerError: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  12. def NoContent: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  13. def NotFound: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  14. def NotImplemented: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  15. def OK: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  16. def Options: Method
    Definition Classes
    Methods → Methods
  17. def Patch: Method
    Definition Classes
    Methods → Methods
  18. def PayloadTooLarge: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  19. def Post: Method
    Definition Classes
    Methods → Methods
  20. def Put: Method
    Definition Classes
    Methods → Methods
  21. def TooManyRequests: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  22. def Unauthorized: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  23. implicit lazy val applicativeRequestExtractor: Applicative[RequestExtractor]
    Definition Classes
    Urls
  24. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  25. final def badRequest[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ClientErrors, A, R]): Response[R]
    Definition Classes
    Responses
  26. implicit def booleanQueryString: QueryStringParam[Boolean]
    Definition Classes
    Urls
  27. def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
    Definition Classes
    Urls → Urls
  28. def choiceRequestEntity[A, B](requestEntityA: RequestEntity[A], requestEntityB: RequestEntity[B]): RequestEntity[Either[A, B]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  29. def choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  30. lazy val clientErrorsResponse: Response[ClientErrors]
    Definition Classes
    Errors
  31. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  32. def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]
    Definition Classes
    Urls → Urls
  33. 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
  34. implicit def doubleQueryString: QueryStringParam[Double]
    Definition Classes
    Urls
  35. implicit def doubleSegment: Segment[Double]
    Definition Classes
    Urls
  36. lazy val emptyRequest: RequestEntity[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  37. lazy val emptyRequestHeaders: RequestHeaders[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  38. def emptyResponse: ResponseEntity[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  39. def emptyResponseHeaders: ResponseHeaders[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  40. def endpoint[A, B](request: Request[A], response: Response[B], docs: EndpointDocs): Endpoint[A, B]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  41. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  42. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  43. def extractMethodUrlAndHeaders[A, B](method: Method, url: Url[A], headers: RequestHeaders[B]): UrlAndHeaders[(A, B)]
    Attributes
    protected
    Definition Classes
    EndpointsWithCustomErrors
  44. implicit lazy val functorRequestExtractor: Functor[RequestExtractor]
    Definition Classes
    Urls
  45. 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
  46. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  47. def handleClientErrors(invalid: Invalid): Result
    Definition Classes
    Urls
  48. def handleServerError(throwable: Throwable): Result
    Definition Classes
    EndpointsWithCustomErrors
  49. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  50. lazy val htmlResponse: ResponseEntity[Html]
    Definition Classes
    EndpointsWithCustomErrors
  51. implicit def intQueryString: QueryStringParam[Int]
    Definition Classes
    Urls
  52. implicit def intSegment: Segment[Int]
    Definition Classes
    Urls
  53. final def internalServerError[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ServerError, A, R]): Response[R]
    Definition Classes
    Responses
  54. implicit lazy val invariantFunctorRequest: play.api.libs.functional.InvariantFunctor[Request]
    Definition Classes
    EndpointsWithCustomErrors
  55. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  56. def jsonRequest[A](implicit arg0: io.circe.Decoder[A]): RequestEntity[A]
    Definition Classes
    JsonEntities → JsonEntities
  57. def jsonResponse[A](implicit arg0: io.circe.Encoder[A]): ResponseEntity[A]
    Definition Classes
    JsonEntities → JsonEntities
  58. implicit def longQueryString: QueryStringParam[Long]
    Definition Classes
    Urls
  59. implicit def longSegment: Segment[Long]
    Definition Classes
    Urls
  60. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  61. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  62. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  63. 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
  64. def optRequestHeader(name: String, docs: Option[String]): (Headers) => Validated[Option[String]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  65. def optResponseHeader(name: String, docs: Documentation): ResponseHeaders[Option[String]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  66. implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]
    Definition Classes
    Urls → Urls
  67. 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
  68. val path: Path[Unit]
    Definition Classes
    Urls
  69. implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]
    Definition Classes
    Urls → Urls
  70. 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
  71. 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
  72. def qs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[A]
    Definition Classes
    Urls → Urls
  73. implicit lazy val queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]
    Definition Classes
    Urls → Urls
  74. implicit lazy val queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]
    Definition Classes
    Urls → Urls
  75. def redirect[A](other: => Endpoint[A, _])(args: A): Response[Unit]
    Definition Classes
    EndpointsWithCustomErrors
  76. def remainingSegments(name: String, docs: Documentation): Path[String]
    Definition Classes
    Urls → Urls
  77. implicit def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: QueryStringParam[A], factory: Factory[A, CC[A]]): QueryStringParam[CC[A]]
    Definition Classes
    Urls → Urls
  78. def request[A, B, C, AB, Out](method: Method, url: Url[A], entity: RequestEntity[B], docs: Documentation, headers: RequestHeaders[C])(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler.Aux[AB, C, Out]): Request[Out]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  79. implicit def requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  80. def requestHeader(name: String, docs: Option[String]): (Headers) => Validated[String]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  81. implicit lazy val requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  82. implicit lazy val requestHeadersSemigroupal: Semigroupal[RequestHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  83. implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  84. def response[A, B, R](statusCode: StatusCode, entity: ResponseEntity[A], docs: Documentation, headers: ResponseHeaders[B])(implicit tupler: Tupler.Aux[A, B, R]): Response[R]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  85. implicit lazy val responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  86. def responseHeader(name: String, docs: Documentation): ResponseHeaders[String]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  87. implicit def responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  88. implicit def responseHeadersSemigroupal: Semigroupal[ResponseHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  89. implicit lazy val responseInvariantFunctor: InvariantFunctor[Response]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  90. def routesFromEndpoints(endpoints: ToPlayHandler*): PartialFunction[RequestHeader, Handler]
    Definition Classes
    EndpointsWithCustomErrors
  91. def segment[A](name: String, docs: Documentation)(implicit A: Segment[A]): Path[A]
    Definition Classes
    Urls → Urls
  92. implicit lazy val segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]
    Definition Classes
    Urls → Urls
  93. lazy val serverErrorResponse: Response[ServerError]
    Definition Classes
    Errors
  94. def staticPathSegment(segment: String): Path[Unit]
    Definition Classes
    Urls → Urls
  95. implicit lazy val stringQueryString: QueryStringParam[String]
    Definition Classes
    Urls → Urls
  96. implicit def stringSegment: Segment[String]
    Definition Classes
    Urls → Urls
  97. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  98. lazy val textRequest: RequestEntity[String]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  99. def textResponse: ResponseEntity[String]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  100. def toString(): String
    Definition Classes
    AnyRef → Any
  101. implicit lazy val urlPartialInvariantFunctor: PartialInvariantFunctor[Url]
    Definition Classes
    Urls → Urls
  102. def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]
    Definition Classes
    Urls → Urls
  103. val utf8Name: String
    Definition Classes
    Urls
  104. implicit def uuidQueryString: QueryStringParam[UUID]
    Definition Classes
    Urls
  105. implicit def uuidSegment: Segment[UUID]
    Definition Classes
    Urls
  106. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  107. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  108. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  109. final def wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation): Response[Option[A]]
    Definition Classes
    Responses

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from algebra.JsonEntities

Inherited from EndpointsWithCustomErrors

Inherited from StatusCodes

Inherited from Methods

Inherited from Urls

Inherited from algebra.EndpointsWithCustomErrors

Inherited from Errors

Inherited from Responses

Inherited from algebra.StatusCodes

Inherited from Requests

Inherited from endpoints4s.SemigroupalSyntax

Inherited from algebra.Methods

Inherited from algebra.Urls

Inherited from endpoints4s.PartialInvariantFunctorSyntax

Inherited from endpoints4s.InvariantFunctorSyntax

Inherited from AnyRef

Inherited from Any

Ungrouped