Documentation

Generates a set of client functions for an API.

Example:

type API = Capture "no" Int :> Get '[JSON] Int
       :<|> Get '[JSON] [Bool]

api :: Proxy API
api = Proxy

getInt :: Int -> ClientM Int
getBools :: ClientM [Bool]
getInt :<|> getBools = client api

ClientM is the monad in which client functions run. Contains the Manager and BaseUrl used for requests in the reader environment.

A runClientM variant for streaming client.

It allows using this module's ClientM in a direct style. The NFData constraint however prevents using this function with genuine streaming response types (SourceT, Conduit, pipes Proxy or Machine). For those you have to use withClientM.

Note: we force the result, so the likelihood of accidentally leaking a connection is smaller. Use with care.

Change the monad the client functions live in, by supplying a conversion function (a natural transformation to be precise).

For example, assuming you have some manager :: Manager and baseurl :: BaseUrl around:

type API = Get '[JSON] Int :<|> Capture "n" Int :> Post '[JSON] Int
api :: Proxy API
api = Proxy
getInt :: IO Int
postInt :: Int -> IO Int
getInt :<|> postInt = hoistClient api (flip runClientM cenv) (client api)
  where cenv = mkClientEnv manager baseurl

TODO: support UVerb (acceptStatus argument, like in performRequest above).

The environment in which a request is run. The baseUrl and makeClientRequest function are used to create a http-client request. Cookies are then added to that request if a CookieJar is set on the environment. Finally the request is executed with the manager. The makeClientRequest function can be used to modify the request to execute and set values which are not specified on a servant Request like responseTimeout or redirectCount

ClientEnv smart constructor.

Create a http-client Request from a servant Request The host, path and port fields are extracted from the BaseUrl otherwise the body, headers and query string are derived from the servant Request

Note that Applicative dependency is not really needed for this function implementation. But in the past the return type was wrapped into IO without a necessity breaking the API backward-compatibility. In order to not break the API again it was changed to Applicative so that you can just use something like Data.Functor.Identity without a need to involve IO but still keeping it compatible with the code written when it was typed as IO.