README.md

servant-client

This library lets you automatically derive Haskell functions that let you query each endpoint of a servant webservice.

Example

type MyApi = "books" :> Get '[JSON] [Book] -- GET /books
        :<|> "books" :> ReqBody Book :> Post '[JSON] Book -- POST /books

myApi :: Proxy MyApi
myApi = Proxy

getAllBooks :: EitherT String IO [Book]
postNewBook :: Book -> EitherT String IO Book
-- 'client' allows you to produce operations to query an API from a client.
(getAllBooks :<|> postNewBook) = client myApi host
  where host = BaseUrl Http "localhost" 8080

Testing

Testing right now is a bit fragile. It makes the following assumptions:

You are running the GHC servant-server in test-server:

cd test-server
stack build
stack exec test-server

And that you have the node package xmlhttprequest in the node directory that GHJCS is pointing to (on my computer it is ~/node_modules, it may differ on your system).

Then you can run:

stack setup
stack test