Trait

endpoints.akkahttp.server

Endpoints

Related Doc: package server

Permalink

trait Endpoints extends algebra.Endpoints with Urls with Methods

Interpreter for algebra.Endpoints that performs routing using akka-http.

Source
Endpoints.scala
Linear Supertypes
Methods, Urls, algebra.Endpoints, Responses, Requests, endpoints.SemigroupalSyntax, endpoints.InvariantFunctorSyntax, algebra.Methods, algebra.Urls, AnyRef, Any
Known Subclasses
BasicAuthentication, JsonEntities, JsonEntitiesFromCodec, JsonSchemaEntities, MuxEndpoints
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Endpoints
  2. Methods
  3. Urls
  4. Endpoints
  5. Responses
  6. Requests
  7. SemigroupalSyntax
  8. InvariantFunctorSyntax
  9. Methods
  10. Urls
  11. AnyRef
  12. 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

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

    Permalink
    Definition Classes
    InvariantFunctorSyntax

  4. type Method = HttpMethod

    Permalink
    Definition Classes
    Methods → Methods

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

    Permalink
    Definition Classes
    Urls

  6. implicit class PathOps[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

  7. class QueryString[T] extends AnyRef

    Permalink
    Definition Classes
    Urls

  8. implicit class QueryStringOps[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

  9. type QueryStringParam[T] = Unmarshaller[String, T]

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    Endpoints → Requests

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

    Permalink
    Definition Classes
    Endpoints → Requests

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

    Permalink
    Definition Classes
    Endpoints → Requests

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

    Permalink
    Definition Classes
    Endpoints → Responses

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

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    SemigroupalSyntax

  16. 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 Delete: HttpMethod

    Permalink
    Definition Classes
    Methods → Methods

  5. def Get: HttpMethod

    Permalink
    Definition Classes
    Methods → Methods

  6. def Options: HttpMethod

    Permalink
    Definition Classes
    Methods → Methods

  7. def Patch: HttpMethod

    Permalink
    Definition Classes
    Methods → Methods

  8. def Post: HttpMethod

    Permalink
    Definition Classes
    Methods → Methods

  9. def Put: HttpMethod

    Permalink
    Definition Classes
    Methods → Methods

  10. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    Urls → Urls

  12. def clone(): AnyRef

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

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

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Attributes
    protected
    Definition Classes
    Urls

  15. lazy val directive1InvFunctor: InvariantFunctor[Directive1]

    Permalink

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

    Permalink
    Definition Classes
    Urls

  17. def emptyHeaders: RequestHeaders[Unit]

    Permalink
    Definition Classes
    Endpoints → Requests

  18. def emptyRequest: RequestEntity[Unit]

    Permalink
    Definition Classes
    Endpoints → Requests

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

    Permalink
    Definition Classes
    Endpoints → Responses

  20. 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

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

    Permalink
    Definition Classes
    AnyRef

  22. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  23. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    Requests

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

    Permalink
    Definition Classes
    AnyRef → Any

  26. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    Endpoints → Requests

  28. implicit def intQueryString: QueryStringParam[Int]

    Permalink
    Definition Classes
    Urls → Urls

  29. implicit def intSegment: Segment[Int]

    Permalink
    Definition Classes
    Urls → Urls

  30. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  31. 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

  32. implicit def longQueryString: QueryStringParam[Long]

    Permalink
    Definition Classes
    Urls → Urls

  33. implicit def longSegment: Segment[Long]

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    AnyRef

  35. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  36. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    Endpoints → Requests

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

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    Endpoints → Responses

  40. val path: Path[Unit]

    Permalink
    Definition Classes
    Urls

  41. 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

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

    Permalink
    Definition Classes
    Urls → Urls

  43. implicit lazy val reqEntityInvFunctor: InvariantFunctor[RequestEntity]

    Permalink
    Definition Classes
    Endpoints → Requests

  44. implicit lazy val reqHeadersInvFunctor: InvariantFunctor[RequestHeaders]

    Permalink
    Definition Classes
    Endpoints → Requests

  45. implicit lazy val reqHeadersSemigroupal: Semigroupal[RequestHeaders]

    Permalink
    Definition Classes
    Endpoints → Requests

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

    Permalink
    Definition Classes
    Endpoints → Requests

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

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    Urls → Urls

  49. implicit def stringQueryString: QueryStringParam[String]

    Permalink
    Definition Classes
    Urls → Urls

  50. implicit def stringSegment: Segment[String]

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    Endpoints → Requests

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

    Permalink
    Definition Classes
    Endpoints → Responses

  54. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  55. implicit lazy val urlInvFunctor: InvariantFunctor[Url]

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    Urls → Urls

  57. final def wait(): Unit

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

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

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

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

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

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