servant/servant-foreign
Philip Patsch e4865644c1 doc(servant-foreign): Document module
I spend some considerable time reverse engineering the module, so I
thought I’d write the documentation I would have liked to see.

The strategy here is that a user not necessarily has insight into how
servant works internally, or even how to write complex servant routes,
they just want to generate a list of endpoints and convert the `Req`
type into e.g. generated code in $language. Thus, they need to know
the semantics of all fields of Req, how they interact and how they
relate to a plain http route.

I made sure every `f` is replaced with `ftype`, so we have one
conventional way of referring to the foreign type argument everywhere.

Some enums are not set at all, they are marked as such.

`_reqBodyContentType` introduces a major restriction of the module, so
that is mentioned in the documentation for now, until the time it will
be fixed.

A few TODO’s describe places where types don’t make sense but would
introduce API-breaking changes, so these should probably be
simplified,
but bundled in one go.
2021-03-25 11:26:53 +01:00
..
src/Servant doc(servant-foreign): Document module 2021-03-25 11:26:53 +01:00
test Add URI fragment as a separate combinator (#1324) 2020-11-18 21:57:20 +03:00
CHANGELOG.md Prepare 0.18.2 release (#1364) 2020-11-22 17:51:32 +03:00
LICENSE Changelog and cabal file edits 2018-11-13 09:58:42 +02:00
README.md Extract common code-generation stuff to servant-foreign 2015-09-21 20:59:09 +03:00
servant-foreign.cabal Prepare 0.18.2 release (#1364) 2020-11-22 17:51:32 +03:00
Setup.hs Apply stylish-haskell on all modules 2018-06-29 23:36:39 +03:00

servant-foreign

servant

Types and helpers for generating clients for servant servers in arbitrary programming languages.