History

David Turner f5d9983381 Rename emptyAPIServer to emptyServer		2017-05-16 15:59:41 +00:00
..
include	less OverlappingInstances noise	2016-01-04 13:09:11 -05:00
src/Servant	Better docs for EmptyAPIClient	2017-05-16 11:06:37 +00:00
test	Rename emptyAPIServer to emptyServer	2017-05-16 15:59:41 +00:00
CHANGELOG.md	Classify changelog into breaking and other changes	2017-02-01 09:06:30 +02:00
docs.sh	prepare merge	2015-04-20 11:15:58 +02:00
LICENSE	Change copyright to servant contributors	2016-01-20 16:58:29 +01:00
README.md	Remove host param from servant-client README.	2016-05-25 17:38:25 +02:00
servant-client.cabal	Bump lower bound for http-api-data	2017-05-14 20:16:38 +03:00
Setup.hs	stylish haskell changes	2015-08-18 00:07:12 +02:00
tinc.yaml	Use tinc on travis	2015-11-05 09:32:13 +08:00

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 :: Manager -> BaseUrl -> ExceptT String IO [Book]
postNewBook :: Book -> Manager -> BaseUrl -> ExceptT String IO Book
-- 'client' allows you to produce operations to query an API from a client.
(getAllBooks :<|> postNewBook) = client myApi