No description
Find a file
2015-07-25 14:13:02 +08:00
scripts rename servant-jquery to servant-js, Servant.JQuery to Servant.JS 2015-07-22 19:25:02 +02:00
servant add stack.yaml and use it in travis file 2015-07-25 14:13:02 +08:00
servant-blaze Cabal file fixes 2015-07-09 23:34:21 +02:00
servant-client add HttpVersion, IsSecure, RemoteHost and Vault combinators with instances for all interpretations (all but the server ones being 'ignore that combinator') 2015-07-10 14:00:01 +02:00
servant-docs Make HasDocs instance for :<|> overlappable. 2015-07-14 15:57:36 +02:00
servant-examples clean up servant-js significantly, simplify the API of the library a lot and document @freezeboy's sweet generators from #159 a bit in the main module of the library, Servant.JS along with how people should use the library. 2015-07-22 19:25:02 +02:00
servant-js add stack.yaml and use it in travis file 2015-07-25 14:13:02 +08:00
servant-lucid Cabal file fixes 2015-07-09 23:34:21 +02:00
servant-mock haddocks for Servant.Mock 2015-07-23 13:00:37 +02:00
servant-server add stack.yaml and use it in travis file 2015-07-25 14:13:02 +08:00
.ghci added servant/.ghci 2014-10-31 15:49:05 +01:00
.gitignore add stack.yaml and use it in travis file 2015-07-25 14:13:02 +08:00
.travis.yml add stack.yaml and use it in travis file 2015-07-25 14:13:02 +08:00
README.md rename servant-jquery to servant-js, Servant.JQuery to Servant.JS 2015-07-22 19:25:02 +02:00
servant.png Update READMEs 2015-04-20 15:48:37 +02:00
sources.txt Merge pull request #163 from haskell-servant/servant-mock 2015-07-24 15:45:08 +02:00
stack.yaml add stack.yaml and use it in travis file 2015-07-25 14:13:02 +08:00

servant

Build Status Coverage Status

servant

These libraries provides a family of combinators to define webservices and automatically generate the documentation and client-side querying functions for each endpoint.

In order to minimize the dependencies depending on your needs, we provide these features under different packages.

  • servant, which contains everything you need to declare a webservice API.
  • servant-server, which lets you implement an HTTP server with handlers for each endpoint of an API.
  • servant-client, which lets you derive automatically Haskell functions that let you query each endpoint of a servant webservice.
  • servant-docs, which lets you generate API docs for your webservice.
  • servant-js, which lets you derive Javascript functions (using vanilla JS ajax requests, angular or jquery) to query your API's endpoints, in the same spirit as servant-client.
  • servant-blaze and servant-lucid provide easy HTML rendering of your data as an HTML content-type "combinator".

Tutorial

We have a tutorial guide that introduces the core types and features of servant. After this article, you should be able to write your first servant webservices, learning the rest from the haddocks' examples.