tapir-sttp-client/sttp.tapir.client.sttp/SttpClientInterpreterExtensions

SttpClientInterpreterExtensions

trait SttpClientInterpreterExtensions
class Object
trait Matchable
class Any

Value members

Concrete methods

def toQuickClient[I, E, O](e: PublicEndpoint[I, E, O, Any], baseUri: Option[Uri]): I => Either[E, O]

Interprets the public endpoint as a synchronous client call, using the given baseUri as the starting point to create the target uri. If baseUri is not provided, the request will be a relative one.

Interprets the public endpoint as a synchronous client call, using the given baseUri as the starting point to create the target uri. If baseUri is not provided, the request will be a relative one.

Returns a function which, when applied to the endpoint's input parameters (given as a tuple), will encode them to appropriate request parameters: path, query, headers and body. The request is sent using a synchronous backend, and the result of decoding the response (error or success value) is returned. If decoding the result fails, an exception is thrown.

def toQuickClientThrowErrors[I, E, O](e: PublicEndpoint[I, E, O, Any], baseUri: Option[Uri]): I => O

Interprets the public endpoint as a client call, using the given baseUri as the starting point to create the target uri. If baseUri is not provided, the request will be a relative one.

Interprets the public endpoint as a client call, using the given baseUri as the starting point to create the target uri. If baseUri is not provided, the request will be a relative one.

Returns a function which, when applied to the endpoint's input parameters (given as a tuple), will encode them to appropriate request parameters: path, query, headers and body. The request is sent using a synchronous backend, and the result (success value) is returned. If decoding the result fails, or if the response corresponds to an error value, an exception is thrown.

def toQuickSecureClient[A, I, E, O](e: Endpoint[A, I, E, O, Any], baseUri: Option[Uri]): A => I => Either[E, O]

Interprets the secure endpoint as a synchronous client call, using the given baseUri as the starting point to create the target uri. If baseUri is not provided, the request will be a relative one.

Interprets the secure endpoint as a synchronous client call, using the given baseUri as the starting point to create the target uri. If baseUri is not provided, the request will be a relative one.

Returns a function which, when applied to the endpoint's security and regular input parameters (given as tuples), will encode them to appropriate request parameters: path, query, headers and body. The request is sent using a synchronous backend, and the result of decoding the response (error or success value) is returned. If decoding the result fails, an exception is thrown.

def toQuickSecureClientThrowErrors[A, I, E, O](e: Endpoint[A, I, E, O, Any], baseUri: Option[Uri]): A => I => O

Interprets the secure endpoint as a client call, using the given baseUri as the starting point to create the target uri. If baseUri is not provided, the request will be a relative one.

Interprets the secure endpoint as a client call, using the given baseUri as the starting point to create the target uri. If baseUri is not provided, the request will be a relative one.

Returns a function which, when applied to the endpoint's security and regular input parameters (given as tuples), will encode them to appropriate request parameters: path, query, headers and body. The request is sent using a synchronous backend, and the result (success value) is returned. If decoding the result fails, or if the response corresponds to an error value, an exception is thrown.