tutorial: tweak some titles
This commit is contained in:
parent
47bc7cd5c3
commit
92431e59b9
5 changed files with 13 additions and 6 deletions
|
@ -3,8 +3,15 @@ servant – A Type-Level Web DSL
|
||||||
|
|
||||||
.. image:: https://raw.githubusercontent.com/haskell-servant/servant/master/servant.png
|
.. 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::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
|
@ -12,7 +12,7 @@ Helpful Links
|
||||||
`https://github.com/haskell-servant/servant/issues <https://github.com/haskell-servant/servant/issues>`_
|
`https://github.com/haskell-servant/servant/issues <https://github.com/haskell-servant/servant/issues>`_
|
||||||
|
|
||||||
- the irc channel:
|
- the irc channel:
|
||||||
#servant on freenode
|
``#servant`` on freenode
|
||||||
|
|
||||||
- the mailing list:
|
- the mailing list:
|
||||||
`groups.google.com/forum/#!forum/haskell-servant <https://groups.google.com/forum/#!forum/haskell-servant>`_
|
`groups.google.com/forum/#!forum/haskell-servant <https://groups.google.com/forum/#!forum/haskell-servant>`_
|
||||||
|
|
|
@ -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.
|
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.
|
||||||
|
|
||||||
|
|
|
@ -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
|
The source for this tutorial section is a literate haskell file, so first we
|
||||||
need to have some language extensions and imports:
|
need to have some language extensions and imports:
|
||||||
|
|
|
@ -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
|
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
|
functions that you can call to query a webservice. The derived code assumes you
|
||||||
|
|
Loading…
Reference in a new issue