Control.Monad.Freer.Http

Documentation

data Http v

The Http effect is for making http requests

get :: Member Http r => String -> Eff r (Response ByteString)

Make a GET request

getJSON :: (FromJSON a, Member Http r) => String -> Eff r a

Make a GET request that expects a JSON response

post :: Member Http r => String -> RequestBody -> Eff r (Response ByteString)

Make a POST request

postJSON :: (FromJSON resp, ToJSON req, Member Http r) => String -> req -> Eff r resp

Make a POST request with a JSON body and response

doRequest :: Member Http r => Request -> Eff r (Response ByteString)

Low level function for making an http request

request :: Member Http r => Method -> RequestHeaders -> String -> Maybe RequestBody -> Eff r (Response ByteString)

Make an HTTP request

requestJSON :: (FromJSON resp, ToJSON req, Member Http r) => Method -> RequestHeaders -> String -> Maybe req -> Eff r resp

Make an HTTP request using JSON for the body and response

data HttpException

An exception which may be generated by this library

Since: http-client-0.5.0

Instances

Show HttpException

Defined in Network.HTTP.Client.Types

Methods

showsPrec :: Int -> HttpException -> ShowS

show :: HttpException -> String

showList :: [HttpException] -> ShowS

Exception HttpException

Defined in Network.HTTP.Client.Types

Methods

toException :: HttpException -> SomeException

fromException :: SomeException -> Maybe HttpException

displayException :: HttpException -> String

newtype JSONParseError

An error that an http response failed to parse

Constructors

JSONParseError String

Instances

Show JSONParseError

Defined in Control.Monad.Freer.Http

Methods

showsPrec :: Int -> JSONParseError -> ShowS

show :: JSONParseError -> String

showList :: [JSONParseError] -> ShowS

runHttp :: forall r w. (Member IO r, Member (Error HttpException) r, Member (Error JSONParseError) r) => Manager -> Eff (Http ': r) w -> Eff r w

Interpret Http using IO and the 'http-client' library

mockHttp :: Eff (Http ': r) w -> (Request -> Response ByteString) -> Eff r w

Interpret Http using a pure function

staticHttpMock :: Eff (Http ': r) w -> Map (Method, ByteString) (Status, ByteString) -> Eff r w

Interpret Http using a static map. Will return a 404 if the method/path are not found in the map