Examples

Helpers for associating example values with all the types we use in our APIs. This allows us to write tests that will warn us when the encoding of our types change, potentially in backwards-incompatible ways.

Documentation

class HasExamples t where

A helper type class that provides us example values of particular types. The IsApi typeclass below will demand we define an instance of this type class for each type used in a request or response body.

Methods

examples :: Proxy t -> Examples

Instances

HasExamples ()

Defined in Examples

Methods

examples :: Proxy () -> Examples

HasExamples NoContent

Defined in Test.Encoding.Routes

Methods

examples :: Proxy NoContent -> Examples

HasExamples Int

Defined in Examples

Methods

examples :: Proxy Int -> Examples

HasExamples Text

Defined in Examples

Methods

examples :: Proxy Text -> Examples

HasExamples a => HasExamples (Maybe a :: Type)

Defined in Examples

Methods

examples :: Proxy (Maybe a) -> Examples

HasExamples a => HasExamples (List a :: Type)

Defined in Examples

Methods

examples :: Proxy (List a) -> Examples

HasExamples a => HasExamples ((a, List a) :: Type)

Defined in Examples

Methods

examples :: Proxy (a, List a) -> Examples

(HasExamples a, HasExamples b) => HasExamples ((a, b) :: Type)

Defined in Examples

Methods

examples :: Proxy (a, b) -> Examples

(HasExamples a, HasExamples b) => HasExamples (Dict a b :: Type)

Defined in Examples

Methods

examples :: Proxy (Dict a b) -> Examples

(HasExamples a, HasExamples b, HasExamples c) => HasExamples ((a, b, c) :: Type)

Defined in Examples

Methods

examples :: Proxy (a, b, c) -> Examples

data Examples

Example values of a type.

Instances

Semigroup Examples

Defined in Examples

Methods

(<>) :: Examples -> Examples -> Examples

sconcat :: NonEmpty Examples -> Examples

stimes :: Integral b => b -> Examples -> Examples

example :: ToJSON a => Text -> a -> Examples

Create an example for a type. Examples consists of a description and an encoded value.

render :: Examples -> Text

Render example values to a Text.