No description
529139eb03
Make sure that no information is lost when providing additional information via docsWith. With the current left-biased implementation of combineAction, this can happen if the function arguments are in the wrong order. |
||
|---|---|---|
| scripts | ||
| servant | ||
| servant-blaze | ||
| servant-client | ||
| servant-docs | ||
| servant-examples | ||
| servant-jquery | ||
| servant-lucid | ||
| servant-server | ||
| .ghci | ||
| .gitignore | ||
| .travis.yml | ||
| README.md | ||
| servant.png | ||
| sources.txt | ||
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 aservantwebservice.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 asservant-client.servant-blazeandservant-lucidprovide easy HTML rendering of your data as anHTMLcontent-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.