No description
Find a file
Alp Mestanogullari 4bcf5158e7 Merge pull request #193 from haskell-servant/servant-server-readme-fix
update readme for servant-server
2015-08-16 11:32:39 +02:00
scripts Make bump-versions.sh work 2015-07-07 17:34:06 +10:00
servant Bump to 0.4.4. 2015-07-30 10:49:40 +02:00
servant-blaze Bump to 0.4.4. 2015-07-30 10:49:40 +02:00
servant-client Bump to 0.4.4. 2015-07-30 10:49:40 +02:00
servant-docs Bump to 0.4.4. 2015-07-30 10:49:40 +02:00
servant-examples Bump to 0.4.4. 2015-07-30 10:49:40 +02:00
servant-jquery Bump to 0.4.4. 2015-07-30 10:49:40 +02:00
servant-lucid Bump to 0.4.4. 2015-07-30 10:49:40 +02:00
servant-server update readme for servant-server 2015-08-16 11:02:47 +02:00
.ghci added servant/.ghci 2014-10-31 15:49:05 +01:00
.gitignore Upload script and some script refactoring 2015-06-09 12:33:19 +02:00
.travis.yml 7.10 changes 2015-04-22 12:27:18 +02:00
README.md tweak README 2015-05-11 10:36:41 +02:00
servant.png Update READMEs 2015-04-20 15:48:37 +02:00
sources.txt Changelog and sources.txt updates 2015-05-02 12:09:00 +02: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-jquery, which lets you derive Javascript functions (based on 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.