Servant.Aeson.Internal

Internal module, use at your own risk.

Documentation

apiRoundtripSpecs :: HasGenericSpecs api => Proxy api -> Spec

Allows to obtain roundtrip tests for JSON serialization for all types used in a servant api.

See also roundtripSpecs.

apiGoldenSpecs :: HasGenericSpecs api => Proxy api -> Spec

Allows to obtain golden tests for JSON serialization for all types used in a servant api.

See also goldenSpecs.

apiSpecs :: HasGenericSpecs api => Proxy api -> Spec

Combination of apiRoundtripSpecs and apiGoldenSpecs.

usedTypes :: HasGenericSpecs api => Proxy api -> [TypeRep]

Allows to retrieve a list of all used types in a servant api as TypeReps.

mkRoundtripSpecs :: HasGenericSpecs api => Proxy api -> [TypeSpec]

class HasGenericSpecs api where

Minimal complete definition

collectRoundtripSpecs

Methods

collectRoundtripSpecs :: Proxy api -> [TypeSpec]

Instances

(HasGenericSpecs a, HasGenericSpecs b) => HasGenericSpecs ((:<|>) a b)

Methods

collectRoundtripSpecs :: Proxy * (a :<|> b) -> [TypeSpec]

(MkTypeSpecs body, HasGenericSpecs api) => HasGenericSpecs ((:>) * * (ReqBody * contentTypes body) api)

Methods

collectRoundtripSpecs :: Proxy * ((* :> *) (ReqBody * contentTypes body) api) -> [TypeSpec]

HasGenericSpecs api => HasGenericSpecs ((:>) Symbol * path api)

Methods

collectRoundtripSpecs :: Proxy * ((Symbol :> *) path api) -> [TypeSpec]

HasGenericSpecs (Verb StdMethod * method returnStatus contentTypes NoContent)

Methods

collectRoundtripSpecs :: Proxy * (Verb StdMethod * method returnStatus contentTypes NoContent) -> [TypeSpec]

MkTypeSpecs response => HasGenericSpecs (Verb StdMethod * method returnStatus contentTypes response)

Methods

collectRoundtripSpecs :: Proxy * (Verb StdMethod * method returnStatus contentTypes response) -> [TypeSpec]

http methods

combinators

data TypeSpec

Constructors

TypeSpec

Fields

• typ :: TypeRep
• roundtrip :: Spec
• golden :: Spec

class MkTypeSpecs a where

Minimal complete definition

mkTypeSpecs

Methods

mkTypeSpecs :: Proxy a -> [TypeSpec]

Instances

MkTypeSpecs ()

Methods

mkTypeSpecs :: Proxy * () -> [TypeSpec]

(Typeable * a, Eq a, Show a, Arbitrary a, ToJSON a, FromJSON a) => MkTypeSpecs a

Methods

mkTypeSpecs :: Proxy * a -> [TypeSpec]

(Eq a, Show a, Typeable * a, Arbitrary a, ToJSON a, FromJSON a) => MkTypeSpecs [a]

Methods

mkTypeSpecs :: Proxy * [a] -> [TypeSpec]

(Eq a, Show a, Typeable * a, Arbitrary a, ToJSON a, FromJSON a) => MkTypeSpecs (Maybe a)

Methods

mkTypeSpecs :: Proxy * (Maybe a) -> [TypeSpec]