git.iko.soy/typeable/servant
on v0.4 help sign in
typeable/servant/README.md
28 lines 2.4 kB history raw
1# servant
3[![Build Status](https://secure.travis-ci.org/haskell-servant/servant.svg)](http://travis-ci.org/haskell-servant/servant)
4[![Coverage Status](https://coveralls.io/repos/haskell-servant/servant/badge.svg)](https://coveralls.io/r/haskell-servant/servant)
6![servant](https://raw.githubusercontent.com/haskell-servant/servant/master/servant.png)
8These libraries provides a family of combinators to define webservices and automatically generate the documentation and client-side querying functions for each endpoint.
10In order to minimize the dependencies depending on your needs, we provide these features under different packages.
12- `servant`, which contains everything you need to *declare* a webservice API.
13- `servant-server`, which lets you *implement* an HTTP server with handlers for each endpoint of an API.
14- `servant-client`, which lets you derive automatically Haskell functions that let you query each endpoint of a `servant` webservice.
15- `servant-docs`, which lets you generate API docs for your webservice.
16- `servant-jquery`, which lets you derive Javascript functions (based on jquery) to query your API's endpoints, in the same spirit as `servant-client`.
18## Getting started
20We've written a [Getting Started](http://haskell-servant.github.io/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.
22## Repositories and Haddocks
24- The core [servant](http://github.com/haskell-servant/tree/master/servant) package - [docs](http://hackage.haskell.org/package/servant)
25- Implementing an HTTP server for a webservice API with [servant-server](http://github.com/haskell-servant/servant/tree/master/servant-server) - [docs](http://hackage.haskell.org/package/servant-server)
26- (Haskell) client-side function generation with [servant-client](http://github.com/haskell-servant/servant/tree/master/servant-client) - [docs](http://hackage.haskell.org/package/servant-client)
27- (Javascript) client-side function generation with [servant-jquery](http://github.com/haskell-servant/servant/tree/master/servant-jquery) - [docs](http://hackage.haskell.org/package/servant-jquery)
28- API docs generation with [servant-docs](http://github.com/haskell-servant/servant/tree/master/servant-docs) - [docs](http://hackage.haskell.org/package/servant-docs)