Trait

endpoints.akkahttp.server

JsonEntities

Related Doc: package server

Permalink

trait JsonEntities extends algebra.JsonEntities with Endpoints

Interpreter for algebra.JsonEntities

To use it mix in support for your favourite Json library You can use one of hseeberger/akka-http-json modules

Source
JsonEntities.scala
Linear Supertypes
Endpoints, Methods, Urls, StatusCodes, algebra.JsonEntities, algebra.Endpoints, Responses, algebra.StatusCodes, Requests, endpoints.SemigroupalSyntax, endpoints.PartialInvariantFunctorSyntax, endpoints.InvariantFunctorSyntax, algebra.Methods, algebra.Urls, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JsonEntities
  2. Endpoints
  3. Methods
  4. Urls
  5. StatusCodes
  6. JsonEntities
  7. Endpoints
  8. Responses
  9. StatusCodes
  10. Requests
  11. SemigroupalSyntax
  12. PartialInvariantFunctorSyntax
  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 class Directive0Ops extends AnyRef

    Permalink
    Definition Classes
    Urls

  2. case class Endpoint[A, B](request: Request[A], response: Response[B]) extends Product with Serializable

    Permalink
    Definition Classes
    Endpoints

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

    Permalink
    Definition Classes
    InvariantFunctorSyntax

  4. type JsonRequest[A] = Unmarshaller[HttpRequest, A]

    Permalink
    Definition Classes
    JsonEntities → JsonEntities

  5. type JsonResponse[A] = Marshaller[A, HttpResponse]

    Permalink
    Definition Classes
    JsonEntities → JsonEntities

  6. type Method = HttpMethod

    Permalink
    Definition Classes
    Methods → Methods

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

    Permalink
    Definition Classes
    PartialInvariantFunctorSyntax

  8. class Path[T] extends Url[T]

    Permalink
    Definition Classes
    Urls

  9. implicit class PathOps[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

  10. class QueryString[T] extends AnyRef

    Permalink
    Definition Classes
    Urls

  11. implicit class QueryStringOps[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

  12. type QueryStringParam[T] = (String, Map[String, Seq[String]]) ⇒ Option[T]

    Permalink

    <invalid inheritdoc annotation>

    <invalid inheritdoc annotation>

    Given a parameter name and a query string content, returns a decoded parameter value of type T, or None if decoding failed

    Definition Classes
    Urls → Urls

  13. type Request[A] = Directive[(A)]

    Permalink
    Definition Classes
    Endpoints → Requests

  14. type RequestEntity[A] = Directive[(A)]

    Permalink
    Definition Classes
    Endpoints → Requests

  15. type RequestHeaders[A] = Directive[(A)]

    Permalink
    Definition Classes
    Endpoints → Requests

  16. type Response[A] = (A) ⇒ Route

    Permalink
    Definition Classes
    Endpoints → Responses

  17. implicit class ResponseExtensions[A] extends AnyRef

    Permalink
    Definition Classes
    Responses

  18. type Segment[T] = PathMatcher[(T)]

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    SemigroupalSyntax

  20. type StatusCode = akka.http.scaladsl.model.StatusCode

    Permalink
    Definition Classes
    StatusCodes → StatusCodes

  21. class Url[T] extends AnyRef

    Permalink
    Definition Classes
    Urls

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 BadRequest: ClientError

    Permalink
    Definition Classes
    StatusCodes → StatusCodes

  5. def Delete: HttpMethod

    Permalink
    Definition Classes
    Methods → Methods

  6. def Get: HttpMethod

    Permalink
    Definition Classes
    Methods → Methods

  7. def NotFound: ClientError

    Permalink
    Definition Classes
    StatusCodes → StatusCodes

  8. def OK: Success

    Permalink
    Definition Classes
    StatusCodes → StatusCodes

  9. def Options: HttpMethod

    Permalink
    Definition Classes
    Methods → Methods

  10. def Patch: HttpMethod

    Permalink
    Definition Classes
    Methods → Methods

  11. def Post: HttpMethod

    Permalink
    Definition Classes
    Methods → Methods

  12. def Put: HttpMethod

    Permalink
    Definition Classes
    Methods → Methods

  13. def Unauthorized: ClientError

    Permalink
    Definition Classes
    StatusCodes → StatusCodes

  14. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  15. implicit def booleanQueryString: QueryStringParam[Boolean]

    Permalink
    Definition Classes
    Urls

  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 clone(): AnyRef

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

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

    Permalink
    Definition Classes
    Urls → Urls

  19. def convToDirective1(directive: Directive0): Directive1[Unit]

    Permalink
    Attributes
    protected
    Definition Classes
    Urls

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

    Permalink
    Definition Classes
    Requests

  21. lazy val directive1InvFunctor: InvariantFunctor[Directive1]

    Permalink
    Definition Classes
    Endpoints

  22. implicit def doubleQueryString: QueryStringParam[Double]

    Permalink
    Definition Classes
    Urls

  23. implicit def doubleSegment: Segment[Double]

    Permalink
    Definition Classes
    Urls

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

    Permalink
    Definition Classes
    Urls

  25. def emptyHeaders: RequestHeaders[Unit]

    Permalink
    Definition Classes
    Endpoints → Requests

  26. def emptyRequest: RequestEntity[Unit]

    Permalink
    Definition Classes
    Endpoints → Requests

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

    Permalink
    Definition Classes
    Endpoints → Responses

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

    Permalink
    Definition Classes
    Endpoints → Endpoints

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

    Permalink
    Definition Classes
    AnyRef

  30. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  31. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    Requests

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

    Permalink
    Definition Classes
    AnyRef → Any

  34. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    Endpoints → Requests

  36. implicit def intQueryString: QueryStringParam[Int]

    Permalink
    Definition Classes
    Urls

  37. implicit def intSegment: Segment[Int]

    Permalink
    Definition Classes
    Urls

  38. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  39. def joinDirectives[T1, T2](dir1: Directive1[T1], dir2: Directive1[T2])(implicit tupler: Tupler[T1, T2]): Directive1[Out]

    Permalink

    Simpler alternative to Directive.&() method

    Simpler alternative to Directive.&() method

    Attributes
    protected
    Definition Classes
    Urls

  40. def jsonRequest[A](docs: Documentation = None)(implicit arg0: JsonRequest[A]): RequestEntity[A]

    Permalink
    Definition Classes
    JsonEntities → JsonEntities

  41. def jsonResponse[A](docs: Documentation = None)(implicit arg0: JsonResponse[A]): Response[A]

    Permalink
    Definition Classes
    JsonEntities → JsonEntities

  42. implicit def longQueryString: QueryStringParam[Long]

    Permalink
    Definition Classes
    Urls

  43. implicit def longSegment: Segment[Long]

    Permalink
    Definition Classes
    Urls

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

    Permalink
    Definition Classes
    AnyRef

  45. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  46. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    Endpoints → Requests

  48. implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]

    Permalink
    Definition Classes
    Urls → Urls

  49. val path: Path[Unit]

    Permalink
    Definition Classes
    Urls

  50. implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]

    Permalink
    Definition Classes
    Urls → Urls

  51. 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]

    Permalink
    Definition Classes
    Requests

  52. 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]

    Permalink
    Definition Classes
    Requests

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

    Permalink
    Definition Classes
    Urls → Urls

  54. implicit lazy val queryStringParamPartialInvFunctor: PartialInvariantFunctor[QueryStringParam]

    Permalink
    Definition Classes
    Urls → Urls

  55. implicit lazy val queryStringPartialInvFunctor: PartialInvariantFunctor[QueryString]

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    Urls

  57. def remainingSegments(name: String, docs: Documentation): Path[String]

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    Urls → Urls

  59. implicit lazy val reqEntityInvFunctor: InvariantFunctor[RequestEntity]

    Permalink
    Definition Classes
    Endpoints → Requests

  60. implicit lazy val reqHeadersInvFunctor: InvariantFunctor[RequestHeaders]

    Permalink
    Definition Classes
    Endpoints → Requests

  61. implicit lazy val reqHeadersSemigroupal: Semigroupal[RequestHeaders]

    Permalink
    Definition Classes
    Endpoints → Requests

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

    Permalink
    Definition Classes
    Endpoints → Requests

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

    Permalink
    Definition Classes
    Urls → Urls

  64. implicit lazy val segmentPartialInvFunctor: PartialInvariantFunctor[Segment]

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    Urls → Urls

  66. implicit lazy val stringQueryString: QueryStringParam[String]

    Permalink
    Definition Classes
    Urls → Urls

  67. implicit def stringSegment: Segment[String]

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    AnyRef

  69. def textRequest(docs: Documentation): RequestEntity[String]

    Permalink
    Definition Classes
    Endpoints → Requests

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

    Permalink
    Definition Classes
    Endpoints → Responses

  71. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  72. implicit lazy val urlPartialInvFunctor: PartialInvariantFunctor[Url]

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    Urls → Urls

  74. implicit def uuidQueryString: QueryStringParam[UUID]

    Permalink
    Definition Classes
    Urls

  75. implicit def uuidSegment: Segment[UUID]

    Permalink
    Definition Classes
    Urls

  76. final def wait(): Unit

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

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

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

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

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

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

    Permalink
    Definition Classes
    Endpoints → Responses

Inherited from Endpoints

Inherited from Methods

Inherited from Urls

Inherited from StatusCodes

Inherited from algebra.JsonEntities

Inherited from algebra.Endpoints

Inherited from Responses

Inherited from algebra.StatusCodes

Inherited from Requests

Inherited from endpoints.SemigroupalSyntax

Inherited from endpoints.PartialInvariantFunctorSyntax

Inherited from endpoints.InvariantFunctorSyntax

Inherited from algebra.Methods

Inherited from algebra.Urls

Inherited from AnyRef

Inherited from Any

Ungrouped