| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Data.API.Tools.Example
Description
Tool for generating documentation-friendly examples
- class Example a where
- exampleTool :: APITool
- samplesTool :: Name -> APITool
Documentation
class Example a where Source #
The Example class is used to generate a documentation-friendly example for each type in the model
Methods
Generator for example values; defaults to arbitrary if not
specified
example :: Arbitrary a => Gen a Source #
Generator for example values; defaults to arbitrary if not
specified
Instances
exampleTool :: APITool Source #
Tool to generate Example instances for types generated by
datatypesTool. This depends on quickCheckTool.
samplesTool :: Name -> APITool Source #
Generate a list of (type name, sample generator) pairs
corresponding to each type in the API, with samples encoded as
JSON. This depends on the Example instances generated by
exampleTool. It generates something like this:
samples :: [(String, Gen Value)]
samples = [("Foo", fmap toJSON (example :: Gen Foo)), ... ]