servant/doc/index.rst

27 lines
918 B
ReStructuredText
Raw Normal View History

2016-02-18 17:02:11 +01:00
servant A Type-Level Web DSL
==============================
.. image:: https://raw.githubusercontent.com/haskell-servant/servant/master/servant.png
2018-06-10 00:43:02 +02:00
**servant** is a set of Haskell libraries for writing *type-safe* web
applications but also *deriving* clients (in Haskell and other languages) or
generating documentation for them, and more.
2016-02-18 18:13:43 +01:00
2018-06-10 00:43:02 +02:00
This is achieved by taking as input a description of the web API
as a Haskell type. Servant is then able to check that your server-side request
handlers indeed implement your web API faithfully, or to automatically derive
Haskell functions that can hit a web application that implements this API,
generate a Swagger description or code for client functions in some other
languages directly.
2016-02-18 18:13:43 +01:00
2018-06-10 00:43:02 +02:00
If you would like to learn more, click the tutorial link below.
.. toctree::
2016-02-18 17:02:11 +01:00
:maxdepth: 2
2016-02-18 17:02:11 +01:00
tutorial/index.rst
cookbook/index.rst
examples.md
2016-02-18 17:02:11 +01:00
links.rst
2018-06-10 00:43:02 +02:00
principles.rst