servant/servant-client/README.md

42 lines
1.1 KiB
Markdown
Raw Permalink Normal View History

2014-12-08 11:10:51 +01:00
# servant-client
![servant](https://raw.githubusercontent.com/haskell-servant/servant/master/servant.png)
2015-02-06 09:34:59 +01:00
This library lets you automatically derive Haskell functions that let you query each endpoint of a *servant* webservice.
2014-12-08 11:10:51 +01:00
## Example
``` haskell
{-# LANGUAGE DataKinds #-}
{-# LANGUAGE TypeOperators #-}
import Data.Proxy
import Data.Text
import Network.HTTP.Client (newManager, defaultManagerSettings)
import Servant.API
import Servant.Client
type Book = Text
type MyApi = "books" :> Get '[JSON] [Book] -- GET /books
:<|> "books" :> ReqBody '[JSON] Book :> Post '[JSON] Book -- POST /books
2014-12-08 11:10:51 +01:00
myApi :: Proxy MyApi
myApi = Proxy
-- 'client' allows you to produce operations to query an API from a client.
postNewBook :: Book -> ClientM Book
getAllBooks :: ClientM [Book]
(getAllBooks :<|> postNewBook) = client myApi
main :: IO ()
main = do
manager' <- newManager defaultManagerSettings
res <- runClientM getAllBooks (mkClientEnv manager' (BaseUrl Http "localhost" 8081 ""))
case res of
Left err -> putStrLn $ "Error: " ++ show err
Right books -> print books
2015-04-20 15:38:26 +02:00
```