No description
Find a file
Alp Mestanogullari 4ff9697ed7 Merge pull request #172 from freezeboy/add-url-prefix
Add urlPrefix to CommonGeneratorOptions
2015-07-28 15:53:48 +02:00
scripts quick chat example base on chat example from engine-io 2015-07-28 05:52:02 -06:00
servant Bump versions to 0.5 2015-07-27 22:26:49 +02:00
servant-blaze Bump versions to 0.5 2015-07-27 22:26:49 +02:00
servant-client Bump versions to 0.5 2015-07-27 22:26:49 +02:00
servant-docs Bump versions to 0.5 2015-07-27 22:26:49 +02:00
servant-examples quick chat example base on chat example from engine-io 2015-07-28 05:52:02 -06:00
servant-js Merge pull request #172 from freezeboy/add-url-prefix 2015-07-28 15:53:48 +02:00
servant-lucid Bump versions to 0.5 2015-07-27 22:26:49 +02:00
servant-mock Bump versions to 0.5 2015-07-27 22:26:49 +02:00
servant-server Bump versions to 0.5 2015-07-27 22:26:49 +02:00
.ghci added servant/.ghci 2014-10-31 15:49:05 +01:00
.gitignore add stack file 2015-07-26 17:25:07 +08:00
.travis.yml 7.10 changes 2015-04-22 12:27:18 +02: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 file 2015-07-26 17:25:07 +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.