servant-client

automatical derivation of querying functions for servant webservices

http://haskell-servant.readthedocs.org/

Version on this page:	0.8.1
LTS Haskell 20.23:	0.19@rev:5
Stackage Nightly 2023-06-04:	0.19@rev:5
Latest on Hackage:	0.19@rev:5

See all snapshots servant-client appears in

BSD-3-Clause licensed by Servant Contributors

Maintained by haskell-servant-maintainers@googlegroups.com

This version can be pinned in stack with:servant-client-0.8.1@sha256:c24a3b56e235afd533c75193dd4b245f99e09b7708b730dd74b169de051bca5a,2977

Module documentation for 0.8.1

Servant
- Servant.Client
  - Servant.Client.Experimental
    - Servant.Client.Experimental.Auth
- Servant.Common

Depends on 18 packages(full list with versions):

aeson, attoparsec, base, base64-bytestring, bytestring, exceptions, http-api-data, http-client, http-client-tls, http-media, http-types, network-uri, safe, servant, string-conversions, text, transformers, transformers-compat

Used by 4 packages in lts-7.24(full list with versions):

giphy-api, language-puppet, smsaero, yahoo-finance-api

servant-client

servant

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

Changes

0.7.1

Support GHC 8.0
ServantError has an Eq instance now.

0.6

client no longer takes BaseUrl and Manager arguments. Instead, each function returned by client requires these two arguments.

0.5

Use the text package instead of String.
Support for the HttpVersion, IsSecure, RemoteHost and Vault combinators
Added support for path on BaseUrl.
client now takes an explicit Manager argument.
Use http-api-data instead of Servant.Common.Text
Client functions now consider any 2xx successful.
Remove matrix params.
Added support for Basic authentication
Add generalized authentication support via the AuthClientData type family and AuthenticateReq data type

0.4.1

The HasClient instance for Delete cts () now does not care at all about content types provided.

0.4

Delete now is like Get, Post, Put, and Patch and returns a response body
Support content-type aware combinators and Accept/Content-type headers
Added a lot of tests
Support multiple concurrent threads
Use ServantError to report Errors instead of String
Make the clients for Raw endpoints return the whole Response value (to be able to access response headers for example)
Support for PATCH
Make () instances expect No Content status code, and not try to decode body.
Add support for response headers

0.2.2

Add TLS support
Add matrix parameter support