eeva/servant
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
bc3f61d615
servant/servant-client-core
History
Oleg Grenrus bc3f61d615 Add Servant.API.Modifiers to servant 
Changes Header, ReqBody and QueryParam to take a modifier list.

Resolves https://github.com/haskell-servant/servant/issues/856

ResponseHeader story turns to be somewhat ugly, but it can be made
elegant when https://github.com/haskell-servant/servant/issues/841 is
implemnted, then we can omit HList aka Header Heterogenous List
implementation.

- servant-server changes:

  Writing server side intepretations is quite simple using
  `unfoldRequestArgument`, which makes Header and QueryParam look quite
  the same.

  `ReqBody` cannot be easily made optional with current design (what that
  would mean: No Content-Type Header?), so that dimensions isn't used
  there.

- Add HasLink for all the rest ComprehensiveAPI combinators
- Add 'tricky' Header', QueryParam' endpoints to ComprehensiveAPI
- servant-docs: Quick'n'dirty implementation. Don't use modifiers information (yet).
2018-01-25 09:10:11 +02:00
..
include Rewrite servant-client. 2017-09-14 09:54:13 -04:00
src/Servant/Client Add Servant.API.Modifiers to servant 2018-01-25 09:10:11 +02:00
test Move BaseUrlSpec 2017-09-14 09:54:13 -04:00
CHANGELOG.md Bump versions and update changelogs. 2017-11-06 11:24:48 +02:00
LICENSE Rewrite servant-client. 2017-09-14 09:54:13 -04:00
README.md Review fixes 2017-09-15 09:15:46 -04:00
servant-client-core.cabal Regenerate .travis.yml 2017-12-10 14:27:40 +02:00
Setup.hs Rewrite servant-client. 2017-09-14 09:54:13 -04: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.