6be6697165
* Simplify test API to use `()` - no awkward values at all. * The test asserts on _entire_ of resulting path now... * ...and fix the ampersand placement, but preserving the order of params left to right. The code also reads a bit better this way... |
||
|---|---|---|
| doc | ||
| src/Servant | ||
| test | ||
| .gitignore | ||
| .travis.yml | ||
| CHANGELOG.yaml | ||
| LICENSE | ||
| README.md | ||
| servant-quickcheck.cabal | ||
| Setup.hs | ||
| stack-ghc-8.0.1.yaml | ||
| stack.yaml | ||
servant-quickcheck
servant-quickcheck provides tools to test properties across entire APIs.
Rather than writing the same tests for each endpoint, with servant-quickcheck
you can simply specify properties every endpoint must meet once and for all.
For example:
followsBestPractices :: Spec
followsBestPractices = describe "my API" $ do
it "follows best practices" $ do
withServantServer myAPI myServer $ \burl ->
serverSatisfies api burl stdArgs
( not500
<%> onlyJsonObjects
<%> getsHaveCacheControlHeader
<%> headsHaveCacheControlHeader
<%> mempty)
Additionally, servant-quickcheck provides a serversEqual function that
generates arbitrary requests (that conform to the description of an API) and
tests that two servers respond identically to them. This can be useful when
refactoring or rewriting an API that should not change.