servant-quickcheck/doc/index.rst
2016-04-22 13:00:23 +02:00

23 lines
752 B
ReStructuredText
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

servant-quickcheck QuickCheck entire APIs
============================================
**servant-quickcheck** provides ways of observing and testing the behaviour of
webservers under arbitrary, but sensible, requests. ('Sensible' here means
requests which have the correct type for their arguments (captures, query
params, headers, and request bodies).)
**servant-quickcheck** can currently:
- Test whether two servers behave identically when provided the same inputs
in the same order;
- Test whether certain properties hold true of an entire API (e.g. that an
API never throws a 500 error);
- Stress test arbitrary endpoints in an API.
.. toctree::
:maxdepth: 1
ServersEqual.lhs
ServerSatisfies.lhs
ServerBenchmark.lhs