Packages

trait Endpoints extends algebra.Endpoints with Urls with Methods with StatusCodes

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

Type Members

  1. case class Endpoint[A, B](request: Request[A], response: Response[B]) extends Product with Serializable
  2. implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    InvariantFunctorSyntax
  3. type Method = HttpMethod
    Definition Classes
    Methods → Methods
  4. implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    PartialInvariantFunctorSyntax
  5. implicit class PathOps[A] extends AnyRef
    Definition Classes
    Urls
  6. type QueryStringParam[T] = (String, Map[String, Seq[String]]) => Validated[T]

    <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
  7. implicit class QueryStringSyntax[A] extends AnyRef
    Definition Classes
    Urls
  8. type Request[A] = Directive[(A)]
    Definition Classes
    Endpoints → Requests
  9. type RequestEntity[A] = Directive[(A)]
    Definition Classes
    Endpoints → Requests
  10. type RequestHeaders[A] = Directive[(A)]
    Definition Classes
    Endpoints → Requests
  11. type Response[A] = (A) => Route
    Definition Classes
    Endpoints → Responses
  12. type ResponseEntity[A] = Marshaller[A, MessageEntity]
    Definition Classes
    Endpoints → Responses
  13. implicit class ResponseSyntax[A] extends AnyRef
    Definition Classes
    Responses
  14. implicit class SemigroupalSyntax[A, F[_]] extends AnyRef
    Definition Classes
    SemigroupalSyntax
  15. type StatusCode = akka.http.scaladsl.model.StatusCode
    Definition Classes
    StatusCodes → StatusCodes
  16. trait Path[A] extends Url[A]
    Definition Classes
    Urls
  17. trait QueryString[T] extends AnyRef
    Definition Classes
    Urls
  18. trait Segment[A] extends AnyRef
    Definition Classes
    Urls
  19. trait Url[A] extends AnyRef
    Definition Classes
    Urls

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: Success
    Definition Classes
    StatusCodes → StatusCodes
  5. def BadRequest: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  6. def Created: Success
    Definition Classes
    StatusCodes → StatusCodes
  7. def Delete: HttpMethod
    Definition Classes
    Methods → Methods
  8. def Forbidden: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  9. def Get: HttpMethod
    Definition Classes
    Methods → Methods
  10. def InternalServerError: ServerError
    Definition Classes
    StatusCodes → StatusCodes
  11. def NoContent: Success
    Definition Classes
    StatusCodes → StatusCodes
  12. def NotFound: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  13. def OK: Success
    Definition Classes
    StatusCodes → StatusCodes
  14. def Options: HttpMethod
    Definition Classes
    Methods → Methods
  15. def Patch: HttpMethod
    Definition Classes
    Methods → Methods
  16. def Post: HttpMethod
    Definition Classes
    Methods → Methods
  17. def Put: HttpMethod
    Definition Classes
    Methods → Methods
  18. def Unauthorized: ClientError
    Definition Classes
    StatusCodes → StatusCodes
  19. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  20. final def badRequest[A](entity: ResponseEntity[A], docs: Documentation): Response[A]
    Definition Classes
    Responses
  21. implicit def booleanQueryString: QueryStringParam[Boolean]
    Definition Classes
    Urls
  22. def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
    Definition Classes
    Urls → Urls
  23. def choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]
    Definition Classes
    Endpoints → Responses
  24. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  25. def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]
    Definition Classes
    Urls → Urls
  26. def convToDirective1(directive: Directive0): Directive1[Unit]
    Attributes
    protected
    Definition Classes
    Urls
  27. 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
  28. lazy val directive1InvFunctor: InvariantFunctor[Directive1]
  29. implicit def doubleQueryString: QueryStringParam[Double]
    Definition Classes
    Urls
  30. implicit def doubleSegment: Segment[Double]
    Definition Classes
    Urls
  31. implicit def dummyPathToUrl[A](p: Path[A]): Url[A]
    Definition Classes
    Urls
  32. def emptyHeaders: RequestHeaders[Unit]
    Definition Classes
    Endpoints → Requests
  33. def emptyRequest: RequestEntity[Unit]
    Definition Classes
    Endpoints → Requests
  34. def emptyResponse: ResponseEntity[Unit]
    Definition Classes
    Endpoints → Responses
  35. def endpoint[A, B](request: Request[A], response: Response[B], summary: Documentation = None, description: Documentation = None, tags: List[String] = Nil): Endpoint[A, B]
    Definition Classes
    Endpoints → Endpoints
  36. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  37. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  38. 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
  39. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  40. def handleClientErrors(invalid: Invalid): StandardRoute

    This method is called by endpoints when decoding a request failed.

    This method is called by endpoints when decoding a request failed.

    The default implementation is to return a route that completes with a Bad Request (400) response containing the error messages as a JSON array of string values.

    This method can be overridden to customize the error reporting logic.

    Definition Classes
    Urls
  41. def handleServerError(throwable: Throwable): StandardRoute

    This method is called by endpoints when an exception is thrown during request processing.

    This method is called by endpoints when an exception is thrown during request processing.

    The default implementation is to return a route that completes with an Internal Server Error (500) response containing the error messages as a JSON array of string values.

    This method can be overridden to customize the error reporting logic.

  42. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  43. def header(name: String, docs: Documentation): RequestHeaders[String]
    Definition Classes
    Endpoints → Requests
  44. implicit def intQueryString: QueryStringParam[Int]
    Definition Classes
    Urls
  45. implicit def intSegment: Segment[Int]
    Definition Classes
    Urls
  46. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  47. def joinDirectives[T1, T2](dir1: Directive1[T1], dir2: Directive1[T2])(implicit tupler: Tupler[T1, T2]): Directive1[Out]

    Simpler alternative to Directive.&() method

    Simpler alternative to Directive.&() method

    Attributes
    protected
    Definition Classes
    Urls
  48. implicit def longQueryString: QueryStringParam[Long]
    Definition Classes
    Urls
  49. implicit def longSegment: Segment[Long]
    Definition Classes
    Urls
  50. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  51. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  52. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  53. final def ok[A](entity: ResponseEntity[A], docs: Documentation): Response[A]
    Definition Classes
    Responses
  54. def optHeader(name: String, docs: Documentation): RequestHeaders[Option[String]]
    Definition Classes
    Endpoints → Requests
  55. implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]
    Definition Classes
    Urls → Urls
  56. val path: Path[Unit]
    Definition Classes
    Urls
  57. implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]
    Definition Classes
    Urls → Urls
  58. 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
  59. 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
  60. def qs[A](name: String, docs: Documentation)(implicit param: QueryStringParam[A]): QueryString[A]
    Definition Classes
    Urls → Urls
  61. implicit lazy val queryStringParamPartialInvFunctor: PartialInvariantFunctor[QueryStringParam]
    Definition Classes
    Urls → Urls
  62. implicit lazy val queryStringPartialInvFunctor: PartialInvariantFunctor[QueryString]
    Definition Classes
    Urls → Urls
  63. def remainingSegments(name: String, docs: Documentation): Path[String]
    Definition Classes
    Urls → Urls
  64. implicit def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: QueryStringParam[A], factory: Factory[A, CC[A]]): QueryStringParam[CC[A]]
    Definition Classes
    Urls → Urls
  65. implicit lazy val reqEntityInvFunctor: InvariantFunctor[RequestEntity]
    Definition Classes
    Endpoints → Requests
  66. implicit lazy val reqHeadersInvFunctor: InvariantFunctor[RequestHeaders]
    Definition Classes
    Endpoints → Requests
  67. implicit lazy val reqHeadersSemigroupal: Semigroupal[RequestHeaders]
    Definition Classes
    Endpoints → Requests
  68. def request[A, B, C, AB, Out](method: Method, url: Url[A], entity: RequestEntity[B] = emptyRequest, docs: Documentation = None, headers: RequestHeaders[C] = emptyHeaders)(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler.Aux[AB, C, Out]): Request[Out]
    Definition Classes
    Endpoints → Requests
  69. def response[A](statusCode: StatusCode, entity: ResponseEntity[A], docs: Documentation = None): Response[A]
    Definition Classes
    Endpoints → Responses
  70. implicit lazy val responseInvFunctor: InvariantFunctor[Response]
    Definition Classes
    Endpoints → Responses
  71. def segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]
    Definition Classes
    Urls → Urls
  72. implicit lazy val segmentPartialInvFunctor: PartialInvariantFunctor[Segment]
    Definition Classes
    Urls → Urls
  73. def staticPathSegment(segment: String): Path[Unit]
    Definition Classes
    Urls → Urls
  74. implicit lazy val stringQueryString: QueryStringParam[String]
    Definition Classes
    Urls → Urls
  75. implicit def stringSegment: Segment[String]
    Definition Classes
    Urls → Urls
  76. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  77. def textRequest: RequestEntity[String]
    Definition Classes
    Endpoints → Requests
  78. def textResponse: ResponseEntity[String]
    Definition Classes
    Endpoints → Responses
  79. def toString(): String
    Definition Classes
    AnyRef → Any
  80. def tryParseString[A](type: String)(parse: (String) => A): (String) => Validated[A]
    Definition Classes
    Urls
  81. implicit lazy val urlPartialInvFunctor: PartialInvariantFunctor[Url]
    Definition Classes
    Urls → Urls
  82. def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]
    Definition Classes
    Urls → Urls
  83. implicit def uuidQueryString: QueryStringParam[UUID]
    Definition Classes
    Urls
  84. implicit def uuidSegment: Segment[UUID]
    Definition Classes
    Urls
  85. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  86. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  87. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  88. final def wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation): Response[Option[A]]
    Definition Classes
    Responses

Deprecated Value Members

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

    (Since version ) see corresponding Javadoc for more information.

Inherited from Methods

Inherited from Urls

Inherited from StatusCodes

Inherited from algebra.Endpoints

Inherited from Responses

Inherited from algebra.StatusCodes

Inherited from Requests

Inherited from endpoints.SemigroupalSyntax

Inherited from algebra.Methods

Inherited from algebra.Urls

Inherited from endpoints.PartialInvariantFunctorSyntax

Inherited from endpoints.InvariantFunctorSyntax

Inherited from AnyRef

Inherited from Any

Ungrouped