servant/servant-client-core
Jan Hrcek f71953e63d
Fix haddock code examples in HasClient (#1640)
2023-01-28 13:02:11 +01:00
..
src/Servant/Client Fix haddock code examples in HasClient (#1640) 2023-01-28 13:02:11 +01:00
test Fix Request's Show instance (#1492) 2021-12-01 19:16:59 +01:00
CHANGELOG.md Changelog tweaks + servant-http-streams / servant-docs bump 2022-02-01 12:29:31 +01:00
LICENSE Changelog and cabal file edits 2018-11-13 09:58:42 +02:00
README.md Review fixes 2017-09-15 09:15:46 -04:00
Setup.hs stylish-haskell servant-client-core 2018-06-30 22:17:08 +03:00
servant-client-core.cabal Allow mtl-2.3, require jose-0.10 (#1627) 2022-11-17 16:58:52 +01:00

README.md

servant-client-core

servant

HTTP-client-agnostic client functions for servant APIs.

This library should mainly be of interest to backend- and combinator-writers.

For backend-writers

If you are creating a new backend, you'll need to:

  1. Define a RunClient instance for your datatype (call it MyMonad)
  2. Define a ClientLike instance. This will look like:
instance ClientLike (MyMonad a) (MyMonad a) where
  mkClient = id
  1. Re-export the module Servant.Client.Core.Reexport so that your end-users can be blissfully unaware of 'servant-client-core', and so each backend-package comes closer to the warm hearth of the drop-in-replacement equivalence class.

For combinator-writers

You'll need to define a new HasClient instance for your combinator. There are plenty of examples to guide you in the HasClient module.