tutorial: tweak some titles

This commit is contained in:
Sönke Hahn 2016-02-18 18:13:43 +01:00
parent 9263f9790f
commit 23d6671c6c
5 changed files with 13 additions and 6 deletions

View file

@ -3,8 +3,15 @@ servant A Type-Level Web DSL
.. image:: https://raw.githubusercontent.com/haskell-servant/servant/master/servant.png
Documentation table of contents
-------------------------------
``servant`` is a set of packages for writing web applications and tools around them.
It allows to
- write servers,
- obtain clients (in haskell),
- generate client functions for other programming languages and
- generate documentation for your web applications.
All in a type-safe manner.
.. toctree::
:maxdepth: 2

View file

@ -12,7 +12,7 @@ Helpful Links
`https://github.com/haskell-servant/servant/issues <https://github.com/haskell-servant/servant/issues>`_
- the irc channel:
#servant on freenode
``#servant`` on freenode
- the mailing list:
`groups.google.com/forum/#!forum/haskell-servant <https://groups.google.com/forum/#!forum/haskell-servant>`_

View file

@ -1,4 +1,4 @@
# Deriving Haskell functions to query an API
# Querying an API
While defining handlers that serve an API has a lot to it, querying an API is simpler: we do not care about what happens inside the webserver, we just need to know how to talk to it and get a response back. Except that we usually have to write the querying functions by hand because the structure of the API isn't a first class citizen and can't be inspected to generate a bunch of client-side functions.

View file

@ -1,4 +1,4 @@
# Generating documentation from API types
# Documenting an API
The source for this tutorial section is a literate haskell file, so first we
need to have some language extensions and imports:

View file

@ -1,4 +1,4 @@
# Deriving Javascript functions to query an API
# Generating Javascript functions to query an API
We will now see how *servant* lets you turn an API type into javascript
functions that you can call to query a webservice. The derived code assumes you