Trait

endpoints.play.server.circe

JsonSchemaEntities

Related Doc: package circe

Permalink

trait JsonSchemaEntities extends Endpoints with algebra.JsonSchemaEntities with JsonSchemas

Interpreter for algebra.JsonEntities that uses circe’s io.circe.Decoder to decode JSON entities in HTTP requests, and circe’s io.circe.Encoder to build JSON entities in HTTP responses.

Source
JsonSchemaEntities.scala
Linear Supertypes
JsonSchemas, algebra.JsonSchemaEntities, JsonSchemas, algebra.JsonEntities, Endpoints, Methods, Urls, algebra.Endpoints, Responses, Requests, endpoints.SemigroupalSyntax, endpoints.InvariantFunctorSyntax, algebra.Methods, algebra.Urls, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JsonSchemaEntities
  2. JsonSchemas
  3. JsonSchemaEntities
  4. JsonSchemas
  5. JsonEntities
  6. Endpoints
  7. Methods
  8. Urls
  9. Endpoints
  10. Responses
  11. Requests
  12. SemigroupalSyntax
  13. InvariantFunctorSyntax
  14. Methods
  15. Urls
  16. AnyRef
  17. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

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

    Permalink
    Definition Classes
    Urls

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

    Permalink
    Definition Classes
    Endpoints

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

    Permalink
    Definition Classes
    Endpoints

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

    Permalink
    Definition Classes
    InvariantFunctorSyntax

  5. type JsonRequest[A] = JsonSchema[A]

    Permalink
    Definition Classes
    JsonSchemaEntities → JsonEntities

  6. type JsonResponse[A] = JsonSchema[A]

    Permalink
    Definition Classes
    JsonSchemaEntities → JsonEntities

  7. trait JsonSchema[A] extends AnyRef

    Permalink
    Definition Classes
    JsonSchemas

  8. implicit final class JsonSchemaOps[A] extends AnyRef

    Permalink
    Definition Classes
    JsonSchemas

  9. case class Method extends Product with Serializable

    Permalink
    Definition Classes
    Methods

  10. trait Path[A] extends Url[A]

    Permalink
    Definition Classes
    Urls

  11. implicit class PathOps[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

  12. trait QueryString[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

  13. implicit class QueryStringOps[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

  14. trait QueryStringParam[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

  15. type Record[A] = JsonSchema[A]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  16. implicit final class RecordOps[A] extends AnyRef

    Permalink
    Definition Classes
    JsonSchemas

  17. trait Request[A] extends AnyRef

    Permalink
    Definition Classes
    Endpoints

  18. type RequestEntity[A] = BodyParser[A]

    Permalink
    Definition Classes
    Endpoints → Requests

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

    Permalink
    Definition Classes
    Urls

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

    Permalink
    Definition Classes
    Endpoints → Requests

  21. type Response[A] = (A) ⇒ Result

    Permalink
    Definition Classes
    Endpoints → Responses

  22. trait Segment[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

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

    Permalink
    Definition Classes
    SemigroupalSyntax

  24. trait Tagged[A] extends Record[A]

    Permalink
    Definition Classes
    JsonSchemas

  25. implicit final class TaggedOps[A] extends AnyRef

    Permalink
    Definition Classes
    JsonSchemas

  26. trait ToPlayHandler extends AnyRef

    Permalink
    Definition Classes
    Endpoints

  27. trait Url[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

  28. trait UrlAndHeaders[A] extends AnyRef

    Permalink
    Definition Classes
    Endpoints

Abstract Value Members

  1. abstract val playComponents: PlayComponents

    Permalink
    Attributes
    protected
    Definition Classes
    Endpoints

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. def Delete: Method

    Permalink
    Definition Classes
    Methods → Methods

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

    Permalink
    Definition Classes
    Endpoints

  6. def Get: Method

    Permalink
    Definition Classes
    Methods → Methods

  7. def Options: Method

    Permalink
    Definition Classes
    Methods → Methods

  8. def Patch: Method

    Permalink
    Definition Classes
    Methods → Methods

  9. def Post: Method

    Permalink
    Definition Classes
    Methods → Methods

  10. def Put: Method

    Permalink
    Definition Classes
    Methods → Methods

  11. implicit lazy val applicativeRequestExtractor: Applicative[RequestExtractor]

    Permalink
    Definition Classes
    Urls

  12. implicit def arrayJsonSchema[C[X] <: Seq[X], A](implicit jsonSchema: JsonSchema[A], cbf: CanBuildFrom[_, A, C[A]]): JsonSchema[C[A]]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  13. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  14. implicit def bigdecimalJsonSchema: JsonSchema[BigDecimal]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  15. implicit def booleanJsonSchema: JsonSchema[Boolean]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

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

    Permalink
    Definition Classes
    Urls → Urls

  17. def choiceTagged[A, B](taggedA: Tagged[A], taggedB: Tagged[B]): Tagged[Either[A, B]]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  18. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    Urls → Urls

  20. implicit def doubleJsonSchema: JsonSchema[Double]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

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

    Permalink
    Definition Classes
    Urls

  22. lazy val emptyHeaders: RequestHeaders[Unit]

    Permalink
    Definition Classes
    Endpoints → Requests

  23. lazy val emptyRequest: BodyParser[Unit]

    Permalink
    Definition Classes
    Endpoints → Requests

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

    Permalink
    Definition Classes
    Endpoints → Responses

  25. def endpoint[A, B](request: Request[A], response: Response[B], summary: Documentation, description: Documentation): Endpoint[A, B]

    Permalink
    Definition Classes
    Endpoints → Endpoints

  26. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  27. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  28. def field[A](name: String, documentation: Option[String])(implicit tpe: JsonSchema[A]): Record[A]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  29. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  30. implicit lazy val functorRequestExtractor: Functor[RequestExtractor]

    Permalink
    Definition Classes
    Urls

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

    Permalink
    Definition Classes
    Requests

  32. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  33. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    Endpoints → Requests

  35. lazy val htmlResponse: Response[Html]

    Permalink
    Definition Classes
    Endpoints

  36. implicit def intJsonSchema: JsonSchema[Int]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  37. implicit def intQueryString: QueryStringParam[Int]

    Permalink
    Definition Classes
    Urls → Urls

  38. implicit def intSegment: Segment[Int]

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    Endpoints

  40. def invmapJsonSchema[A, B](jsonSchema: JsonSchema[A], f: (A) ⇒ B, g: (B) ⇒ A): JsonSchema[B]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  41. def invmapRecord[A, B](record: Record[A], f: (A) ⇒ B, g: (B) ⇒ A): Record[B]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  42. def invmapTagged[A, B](tagged: Tagged[A], f: (A) ⇒ B, g: (B) ⇒ A): Tagged[B]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  43. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  44. def jsonRequest[A](docs: Documentation)(implicit arg0: JsonSchema[A]): RequestEntity[A]

    Permalink
    Definition Classes
    JsonSchemaEntities → JsonEntities

  45. def jsonResponse[A](docs: Documentation)(implicit arg0: JsonSchema[A]): Response[A]

    Permalink
    Definition Classes
    JsonSchemaEntities → JsonEntities

  46. implicit def longJsonSchema: JsonSchema[Long]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  47. implicit def longQueryString: QueryStringParam[Long]

    Permalink
    Definition Classes
    Urls → Urls

  48. implicit def longSegment: Segment[Long]

    Permalink
    Definition Classes
    Urls → Urls

  49. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  50. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  51. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  52. def optField[A](name: String, documentation: Option[String])(implicit tpe: JsonSchema[A]): Record[Option[A]]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  53. def optHeader(name: String, docs: Option[String]): (Headers) ⇒ Either[Result, Option[String]]

    Permalink
    Definition Classes
    Endpoints → Requests

  54. def optQs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[Option[A]]

    Permalink
    Definition Classes
    Urls → Urls

  55. def option[A](response: Response[A], notFoundDocs: Documentation): Response[Option[A]]

    Permalink
    Definition Classes
    Endpoints → Responses

  56. val path: Path[Unit]

    Permalink
    Definition Classes
    Urls

  57. final def post[UrlP, BodyP, HeadersP, UrlAndBodyPTupled](url: Url[UrlP], entity: RequestEntity[BodyP], headers: RequestHeaders[HeadersP])(implicit tuplerAB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerABC: Tupler[UrlAndBodyPTupled, HeadersP]): Request[Out]

    Permalink
    Definition Classes
    Requests

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

    Permalink
    Definition Classes
    Urls → Urls

  59. def redirect[A](other: ⇒ Endpoint[A, _])(args: A): Response[Unit]

    Permalink
    Definition Classes
    Endpoints

  60. implicit def reqEntityInvFunctor: InvariantFunctor[RequestEntity]

    Permalink
    Definition Classes
    Endpoints → Requests

  61. implicit lazy val reqHeadersInvFunctor: InvariantFunctor[RequestHeaders]

    Permalink
    Definition Classes
    Endpoints → Requests

  62. implicit lazy val reqHeadersSemigroupal: Semigroupal[RequestHeaders]

    Permalink
    Definition Classes
    Endpoints → Requests

  63. def request[A, B, C, AB](method: Method, url: Url[A], entity: RequestEntity[B], headers: RequestHeaders[C])(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler[AB, C]): Request[Out]

    Permalink
    Definition Classes
    Endpoints → Requests

  64. def routesFromEndpoints(endpoints: ToPlayHandler*): PartialFunction[RequestHeader, Handler]

    Permalink
    Definition Classes
    Endpoints

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

    Permalink
    Definition Classes
    Urls → Urls

  66. def staticPathSegment(segment: String): Path[Unit]

    Permalink
    Definition Classes
    Urls → Urls

  67. implicit def stringJsonSchema: JsonSchema[String]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  68. implicit def stringQueryString: QueryStringParam[String]

    Permalink
    Definition Classes
    Urls → Urls

  69. implicit def stringSegment: Segment[String]

    Permalink
    Definition Classes
    Urls → Urls

  70. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  71. def taggedRecord[A](recordA: Record[A], tag: String): Tagged[A]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  72. def textRequest(docs: Documentation): BodyParser[String]

    Permalink
    Definition Classes
    Endpoints → Requests

  73. def textResponse(docs: Documentation): Response[String]

    Permalink
    Definition Classes
    Endpoints → Responses

  74. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  75. implicit lazy val urlInvFunctor: InvariantFunctor[Url]

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    Urls → Urls

  77. val utf8Name: String

    Permalink
    Definition Classes
    Urls

  78. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  79. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  80. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  81. def zipRecords[A, B](recordA: Record[A], recordB: Record[B]): Record[(A, B)]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

Inherited from JsonSchemas

Inherited from algebra.JsonSchemaEntities

Inherited from JsonSchemas

Inherited from algebra.JsonEntities

Inherited from Endpoints

Inherited from Methods

Inherited from Urls

Inherited from algebra.Endpoints

Inherited from Responses

Inherited from Requests

Inherited from endpoints.SemigroupalSyntax

Inherited from endpoints.InvariantFunctorSyntax

Inherited from algebra.Methods

Inherited from algebra.Urls

Inherited from AnyRef

Inherited from Any

Ungrouped