Data.API.Tools.Example

Tool for generating documentation-friendly examples

Documentation

class Example a where

The Example class is used to generate a documentation-friendly example for each type in the model

Minimal complete definition

Nothing

Methods

example :: Gen a

Generator for example values; defaults to arbitrary if not specified

Instances

Example Bool

Example Int

Example Text

Example UTCTime

Example Value

Example Binary

Example DefaultValue

Example BasicType

Example TypeRef

Example APIType

Example Field

Example Conversion

Example UTCRange

Example IntRange

Example RegularExpression

Example Filter

Example SpecNewtype

Example Spec

Example APINode

Example a => Example [a]

Example a => Example (Maybe a)

exampleTool :: APITool

Tool to generate Example instances for types generated by datatypesTool. This depends on quickCheckTool.

samplesTool :: Name -> APITool

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)), ... ]