MuxEndpoints

Type Members

abstract type Endpoint[A, B]

Information carried by an HTTP endpoint
Information carried by an HTTP endpoint

Definition Classes
Endpoints
implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef

Definition Classes
InvariantFunctorSyntax
abstract type Method

Definition Classes
Methods
abstract type MuxEndpoint[Req <: MuxRequest, Resp, Transport]

Information carried by a multiplexed HTTP endpoint.
abstract type Path[A] <: Url[A]

An URL path carrying an A information
An URL path carrying an A information

Definition Classes
Urls
implicit class PathOps[A] extends AnyRef

Convenient methods for Paths.
Convenient methods for Paths.

Definition Classes
Urls
abstract type QueryString[A]

A query string carrying an A information
A query string carrying an A information

Definition Classes
Urls
implicit class QueryStringOps[A] extends AnyRef

Provides convenient methods on QueryString.
Provides convenient methods on QueryString.

Definition Classes
Urls
abstract type QueryStringParam[A]

A single query string parameter carrying an A information.
A single query string parameter carrying an A information.

Definition Classes
Urls
abstract type Request[A]

Information carried by a whole request (headers and entity)
Information carried by a whole request (headers and entity)

Definition Classes
Requests
abstract type RequestEntity[A]

Information carried by request entity
Information carried by request entity

Definition Classes
Requests
abstract type RequestHeaders[A]

Information carried by requests’ headers
Information carried by requests’ headers

Definition Classes
Requests
abstract type Response[A]

Information carried by a response
Information carried by a response

Definition Classes
Responses
abstract type Segment[A]

An URL path segment carrying an A information.
An URL path segment carrying an A information.

Definition Classes
Urls
implicit class SemigroupalSyntax[A, F[_]] extends AnyRef

Definition Classes
SemigroupalSyntax
abstract type Url[A]

An URL carrying an A information
An URL carrying an A information

Definition Classes
Urls

Abstract Value Members

abstract def Delete: Method

Definition Classes
Methods
abstract def Get: Method

Definition Classes
Methods
abstract def Options: Method

Definition Classes
Methods
abstract def Patch: Method

Definition Classes
Methods
abstract def Post: Method

Definition Classes
Methods
abstract def Put: Method

Definition Classes
Methods
abstract def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]

Chains the two paths
Chains the two paths

Definition Classes
Urls
abstract def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]

Concatenates two QueryStrings
Concatenates two QueryStrings

Definition Classes
Urls
abstract def emptyHeaders: RequestHeaders[Unit]

No particular information.
No particular information. Does not mean that the headers *have to* be empty. Just that, from a server point of view no information will be extracted from them, and from a client point of view no particular headers will be built in the request.

Definition Classes
Requests
abstract def emptyRequest: RequestEntity[Unit]

Empty request.
Empty request.

Definition Classes
Requests
abstract def emptyResponse(docs: Documentation = None): Response[Unit]

Empty response.
Empty response.

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

HTTP endpoint.
HTTP endpoint.
request
Request
response
Response
summary
optional summary documentation
description
optional description documentation
tags
list of OpenApi tags

Definition Classes
Endpoints
abstract def header(name: String, docs: Documentation = None): RequestHeaders[String]

Definition Classes
Requests
implicit abstract def intQueryString: QueryStringParam[Int]

Ability to define Int query string parameters
Ability to define Int query string parameters

Definition Classes
Urls
implicit abstract def intSegment: Segment[Int]

Ability to define Int path segments
Ability to define Int path segments

Definition Classes
Urls
implicit abstract def longQueryString: QueryStringParam[Long]

Query string parameter containing a Long value
Query string parameter containing a Long value

Definition Classes
Urls
implicit abstract def longSegment: Segment[Long]

Segment containing a Long value
Segment containing a Long value

Definition Classes
Urls
abstract def muxEndpoint[Req <: MuxRequest, Resp, Transport](request: Request[Transport], response: Response[Transport]): MuxEndpoint[Req, Resp, Transport]

Multiplexed HTTP endpoint.
Multiplexed HTTP endpoint.
A multiplexing endpoint makes it possible to use several request and response types in the same HTTP endpoint. In other words, it allows to define several different actions through a singe HTTP endpoint.
Req
The base type of possible requests
Resp
The base type of possible responses
Transport
The data type used to transport the requests and responses
request
The request
response
The response
abstract def optHeader(name: String, docs: Documentation = None): RequestHeaders[Option[String]]

Definition Classes
Requests
abstract def optQs[A](name: String, docs: Documentation = None)(implicit value: QueryStringParam[A]): QueryString[Option[A]]

Builds a QueryString with one optional parameter of type A.
Builds a QueryString with one optional parameter of type A.
name
Parameter’s name

Definition Classes
Urls
abstract def option[A](response: Response[A], notFoundDocs: Documentation = None): Response[Option[A]]

Turns a Response[A] into a Response[Option[A]].
Turns a Response[A] into a Response[Option[A]].
Concrete interpreters should represent None with an empty HTTP response whose status code is 404 (Not Found).

Definition Classes
Responses
abstract def qs[A](name: String, docs: Documentation = None)(implicit value: QueryStringParam[A]): QueryString[A]

Builds a QueryString with one parameter.
Builds a QueryString with one parameter.
A
Type of the value carried by the parameter
name
Parameter’s name

Definition Classes
Urls
implicit abstract def reqEntityInvFunctor: InvariantFunctor[RequestEntity]

Definition Classes
Requests
implicit abstract def reqHeadersInvFunctor: InvariantFunctor[RequestHeaders]

Definition Classes
Requests
implicit abstract def reqHeadersSemigroupal: Semigroupal[RequestHeaders]

Definition Classes
Requests
abstract def request[UrlP, BodyP, HeadersP, UrlAndBodyPTupled](method: Method, url: Url[UrlP], entity: RequestEntity[BodyP] = emptyRequest, headers: RequestHeaders[HeadersP] = emptyHeaders)(implicit tuplerAB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerABC: Tupler[UrlAndBodyPTupled, HeadersP]): Request[Out]

Request for given parameters
Request for given parameters
UrlP
Payload carried by url
BodyP
Payload carried by body
HeadersP
Payload carried by headers
UrlAndBodyPTupled
Payloads of Url and Body tupled together by Tupler
method
Request method
url
Request URL
entity
Request entity
headers
Request headers

Definition Classes
Requests
abstract def segment[A](name: String = "", docs: Documentation = None)(implicit s: Segment[A]): Path[A]

Builds a path segment carrying an A information
Builds a path segment carrying an A information

Definition Classes
Urls
abstract def staticPathSegment(segment: String): Path[Unit]

Builds a static path segment
Builds a static path segment

Definition Classes
Urls
implicit abstract def stringQueryString: QueryStringParam[String]

Ability to define String query string parameters
Ability to define String query string parameters

Definition Classes
Urls
implicit abstract def stringSegment: Segment[String]

Ability to define String path segments
Ability to define String path segments

Definition Classes
Urls
abstract def textRequest(docs: Documentation = None): RequestEntity[String]

Request with string body.
Request with string body.

Definition Classes
Requests
abstract def textResponse(docs: Documentation = None): Response[String]

Text response.
Text response.

Definition Classes
Responses
implicit abstract def urlInvFunctor: InvariantFunctor[Url]

Definition Classes
Urls
abstract def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]

Builds an URL from the given path and query string
Builds an URL from the given path and query string

Definition Classes
Urls

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
implicit def dummyPathToUrl[A](p: Path[A]): Url[A]

Implicit conversion to get rid of intellij errors when defining paths.
Implicit conversion to get rid of intellij errors when defining paths. Effectively should not be called.

Definition Classes
Urls
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def get[UrlP, HeadersP](url: Url[UrlP], headers: RequestHeaders[HeadersP] = emptyHeaders)(implicit tuplerAC: Tupler[UrlP, HeadersP]): Request[Out]

Helper method to perform GET request
Helper method to perform GET request
UrlP
Payload carried by url
HeadersP
Payload carried by headers

Definition Classes
Requests
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val path: Path[Unit]

An empty path.
An empty path.
Useful to begin a path definition:
```
path / "foo" / segment[Int] /? qs[String]("bar")
```
Definition Classes
Urls
final def post[UrlP, BodyP, HeadersP, UrlAndBodyPTupled](url: Url[UrlP], entity: RequestEntity[BodyP], headers: RequestHeaders[HeadersP] = emptyHeaders)(implicit tuplerAB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerABC: Tupler[UrlAndBodyPTupled, HeadersP]): Request[Out]

Helper method to perform POST request
Helper method to perform POST request
UrlP
Payload carried by url
BodyP
Payload carried by body
HeadersP
Payload carried by headers
UrlAndBodyPTupled
Payloads of Url and Body tupled together by Tupler

Definition Classes
Requests
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package algebra

trait MuxEndpoints extends Endpoints

Type Members

abstract type Endpoint[A, B]

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

abstract type Method

abstract type MuxEndpoint[Req <: MuxRequest, Resp, Transport]

abstract type Path[A] <: Url[A]

implicit class PathOps[A] extends AnyRef

abstract type QueryString[A]

implicit class QueryStringOps[A] extends AnyRef

abstract type QueryStringParam[A]

abstract type Request[A]

abstract type RequestEntity[A]

abstract type RequestHeaders[A]

abstract type Response[A]

abstract type Segment[A]

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

abstract type Url[A]

Abstract Value Members

abstract def Delete: Method

abstract def Get: Method

abstract def Options: Method

abstract def Patch: Method

abstract def Post: Method

abstract def Put: Method

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

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

abstract def emptyHeaders: RequestHeaders[Unit]

abstract def emptyRequest: RequestEntity[Unit]

abstract def emptyResponse(docs: Documentation = None): Response[Unit]

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

abstract def header(name: String, docs: Documentation = None): RequestHeaders[String]

implicit abstract def intQueryString: QueryStringParam[Int]

implicit abstract def intSegment: Segment[Int]

implicit abstract def longQueryString: QueryStringParam[Long]

implicit abstract def longSegment: Segment[Long]

abstract def muxEndpoint[Req <: MuxRequest, Resp, Transport](request: Request[Transport], response: Response[Transport]): MuxEndpoint[Req, Resp, Transport]

abstract def optHeader(name: String, docs: Documentation = None): RequestHeaders[Option[String]]

abstract def optQs[A](name: String, docs: Documentation = None)(implicit value: QueryStringParam[A]): QueryString[Option[A]]

abstract def option[A](response: Response[A], notFoundDocs: Documentation = None): Response[Option[A]]

abstract def qs[A](name: String, docs: Documentation = None)(implicit value: QueryStringParam[A]): QueryString[A]

implicit abstract def reqEntityInvFunctor: InvariantFunctor[RequestEntity]

implicit abstract def reqHeadersInvFunctor: InvariantFunctor[RequestHeaders]

implicit abstract def reqHeadersSemigroupal: Semigroupal[RequestHeaders]

abstract def segment[A](name: String = "", docs: Documentation = None)(implicit s: Segment[A]): Path[A]

abstract def staticPathSegment(segment: String): Path[Unit]

implicit abstract def stringQueryString: QueryStringParam[String]

implicit abstract def stringSegment: Segment[String]

abstract def textRequest(docs: Documentation = None): RequestEntity[String]

abstract def textResponse(docs: Documentation = None): Response[String]

implicit abstract def urlInvFunctor: InvariantFunctor[Url]

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

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

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

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

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

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val path: Path[Unit]

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

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Endpoints

Inherited from Responses