servant/doc/index.rst

25 lines
662 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
2016-02-18 22:12:27 +01:00
**servant** is a set of packages for declaring web APIs at the type-level and
2016-02-18 18:17:56 +01:00
then using those API specifications to:
2016-02-18 18:13:43 +01:00
2016-02-18 22:12:27 +01:00
- write servers (this part of **servant** can be considered a web framework),
2016-02-18 18:17:56 +01:00
- obtain client functions (in haskell),
2016-02-23 13:42:48 +01:00
- generate client functions for other programming languages,
- generate documentation for your web applications
- and more...
2016-02-18 18:13:43 +01:00
All in a type-safe manner.
.. toctree::
2016-02-18 17:02:11 +01:00
:maxdepth: 2
2016-02-18 17:02:11 +01:00
introduction.rst
tutorial/index.rst
cookbook/index.rst
examples.md
2016-02-18 17:02:11 +01:00
links.rst