No description
Find a file
Julian K. Arni 7f7ab2c804 Use hackage doc links.
Rather than our own stale ones.
2015-02-18 13:18:28 +01:00
src/Servant Merge pull request #11 from anchor/patch-method 2015-02-15 00:59:19 +08:00
test Flip safeLink and rename link to toLink 2015-01-30 11:03:48 +11:00
.ghci added servant/.ghci 2014-10-31 15:49:05 +01:00
.gitignore Bumped version number, and added a .gitignore file. 2015-01-15 10:38:59 +01:00
.travis.yml Tweak .travis.yml 2015-01-29 11:18:16 +11:00
docs.sh add script for generating the docs and pushing them to github-pages 2014-12-02 18:35:11 +01:00
LICENSE tweaked copyright holder 2014-10-30 15:47:54 +08:00
README.md Use hackage doc links. 2015-02-18 13:18:28 +01:00
servant.cabal Merge pull request #11 from anchor/patch-method 2015-02-15 00:59:19 +08:00
servant.png polish up cabal file, add a README 2014-12-08 10:56:02 +01:00
Setup.hs beginning of a new implementation, using Soenke's typed rest 2014-10-21 15:25:34 +02:00
test-docs.sh Rewrite Utils.Links to export a nicer API. 2015-01-29 10:07:01 +11:00
TODO.md add a TODO 2014-12-05 11:39:25 +01:00
update-nixpkgs.sh Added update-nixpkgs.sh script. 2015-01-09 18:04:36 +01:00

servant

Build 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.

Getting started

We've written a Getting Started 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.

Repositories and Haddocks