symantic-http: Symantic combinators for deriving clients or a server from an HTTP API

[ gpl, library, protocol ] [ Propose Tags ]

An extensible, typed and embedded Domain-Specific Language (DSL) to build Web services using a write-an-API-then-derive-code-from-it approach as in servant's, but with term-level combinators instead of type-level combinators.

In this approach, writting an API can be understood like the writing of a printf's or scanf's format: such that deriving a client is like calling printf on both this format and arguments type-checking against the given format, and deriving a server is like calling scanf on both this format and handlers type-checking against the given format.

For learning how to use this library, you can read the demo example in symantic-http-demo.

WARNING: Be aware that this library is young (thus its interface can change without warnings and delays), has no community explicitely committed to support it (thus can die without warning), is poorly tested (thus even less ready for serious work), and — last but not least — is yours as a common for the commons (with the help of its GNU GPLv3 license).

Users of this library can be grateful to the servant's contributors whose work was helpful to have a concrete overview of the functionnalities this library could attain, and thank Oleg Kiselyov whose (once again) mind-blowing (co-)work on typed formatting was helpful to overcome the limitation of one-type-parameter symantics. Indeed the fundamental observation upon which this library is built is that one-type-parameter symantics (repr a) (aka. Tagless-Final typed DSL — basically just a clever use of type classes and instances) can be augmented with an extension type (repr (a -> k) k) extending a function to the right — while forming a category. Which makes term-level combinators able to add arguments to a function within the type they will be instantiated to (repr), such that this library's combinators (that you can extend by just writing a new type class) can be used to write an API instantiable as: a function asking arguments to generate a client's request, or a function asking handlers to generate a server's response, or some documentation type, or any other type for which you can write the type class instances required by the API combinators you use.

Versions [faq] 0.0.0.20190324, 0.1.1.20190410
Dependencies base (>=4.10 && <5), bytestring (>=0.10), http-api-data (>=0.4), http-media (>=0.7), http-types (>=0.12), network-uri (>=2.6), stm (>=2.4.5), text (>=1.2), time (>=1.8), transformers (>=0.5) [details]
License GPL-3.0-only
Author Julien Moutinho <julm+symantic-http@autogeree.net>
Maintainer Julien Moutinho <julm+symantic-http@autogeree.net>
Category Protocol
Bug tracker Julien Moutinho <julm+symantic-http@autogeree.net>
Source repo head: git clone git://git.autogeree.net/symantic-http
Uploaded by julm at Mon Mar 25 16:18:29 UTC 2019
Distributions NixOS:0.1.1.20190410
Downloads 192 total (24 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2019-03-25 [all 1 reports]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees