WebApi.Client

Provides a client for a web api for a given contract.

Client related functions

client :: forall m r. (CookieOut m r ~ (), ToParam PathParam (PathParam m r), ToParam QueryParam (QueryParam m r), ToParam FormParam (FormParam m r), ToHeader (HeaderIn m r), ToParam FileParam (FileParam m r), FromHeader (HeaderOut m r), Decodings (ContentTypes m r) (ApiOut m r), Decodings (ContentTypes m r) (ApiErr m r), SingMethod m, MkPathFormatString r, PartEncodings (RequestBody m r), ToHListRecTuple (StripContents (RequestBody m r))) => ClientSettings -> Request m r -> IO (Response m r)

Given a Request type, create the request and obtain a response. Gives back a Response.

fromClientResponse :: forall m r. (FromHeader (HeaderOut m r), Decodings (ContentTypes m r) (ApiOut m r), Decodings (ContentTypes m r) (ApiErr m r), CookieOut m r ~ ()) => Response BodyReader -> IO (Response m r)

Creates the Response type from the response body.

toClientRequest :: forall m r. (ToParam PathParam (PathParam m r), ToParam QueryParam (QueryParam m r), ToParam FormParam (FormParam m r), ToHeader (HeaderIn m r), ToParam FileParam (FileParam m r), SingMethod m, MkPathFormatString r, PartEncodings (RequestBody m r), ToHListRecTuple (StripContents (RequestBody m r))) => Request -> Request m r -> IO Request

Creates a request from the Request type.

link :: (ToParam QueryParam (QueryParam m r), MkPathFormatString r, ToParam PathParam (PathParam m r)) => route m r -> URI -> PathParam m r -> Maybe (QueryParam m r) -> URI

Generate a type safe URL for a given route type. The URI can be used for setting a base URL if required.

Types

data ClientSettings

Datatype representing the settings related to client.

Constructors

ClientSettings

Fields

baseUrl :: String

base url of the API being called.

connectionManager :: Manager

connection manager for the connection.

data UnknownClientException

This exception is used to signal an irrecoverable error while deserializing the response.

Instances

Show UnknownClientException

Exception UnknownClientException

Connection manager

data Manager :: *

Instances

HasHttpManager Manager

newManager :: ManagerSettings -> IO Manager

closeManager :: Manager -> IO ()

withManager :: ManagerSettings -> (Manager -> IO a) -> IO a

class HasHttpManager a where

Methods

getHttpManager :: a -> Manager

Instances

HasHttpManager Manager

Connection manager settings

data ManagerSettings :: *

defaultManagerSettings :: ManagerSettings

tlsManagerSettings :: ManagerSettings