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. It uses settings are not used in roundtripSpecs. There is no need to let the user pass cusomt settings. It automatically uses defaultSettings.

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.

apiGoldenSpecsWithSettings :: HasGenericSpecs api => Settings -> Proxy api -> Spec

Same as apiGoldenSpecs, but allows custom settings.

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

Combination of apiRoundtripSpecs and apiGoldenSpecs.

apiSpecsWithSettings :: HasGenericSpecs api => Settings -> Proxy api -> Spec

Same as apiSpecs, but allows custom settings.

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

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

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

Make roundtrip test for all the routes in an API, remove duplicates.

class HasGenericSpecs api where

Allows you to iterate over the routes of a Servant API

Minimal complete definition

collectRoundtripSpecs

Methods

collectRoundtripSpecs :: Settings -> Proxy api -> [TypeSpec]

Instances

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

Match :<|>.

Methods

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

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

Match ReqBody and :>.

Methods

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

HasGenericSpecs api => HasGenericSpecs ((:>) * (QueryParam sym x) api)

Match QueryParam and :>.

Methods

collectRoundtripSpecs :: Settings -> Proxy * ((* :> QueryParam sym x) api) -> [TypeSpec]

HasGenericSpecs api => HasGenericSpecs ((:>) * (QueryParams sym x) api)

Match QueryParams and :>.

Methods

collectRoundtripSpecs :: Settings -> Proxy * ((* :> QueryParams sym x) api) -> [TypeSpec]

HasGenericSpecs api => HasGenericSpecs ((:>) * (QueryFlag sym) api)

Match QueryFlag and :>.

Methods

collectRoundtripSpecs :: Settings -> Proxy * ((* :> QueryFlag sym) api) -> [TypeSpec]

HasGenericSpecs api => HasGenericSpecs ((:>) * (Header * sym x) api)

Match Header and :>.

Methods

collectRoundtripSpecs :: Settings -> Proxy * ((* :> Header * sym x) api) -> [TypeSpec]

HasGenericSpecs api => HasGenericSpecs ((:>) * (AuthProtect Symbol sym) api)

Servant >= 0.5.0, match AuthProtect and :>.

Methods

collectRoundtripSpecs :: Settings -> Proxy * ((* :> AuthProtect Symbol sym) api) -> [TypeSpec]

HasGenericSpecs api => HasGenericSpecs ((:>) * (Capture sym x) api)

Match Capture and :>.

Methods

collectRoundtripSpecs :: Settings -> Proxy * ((* :> Capture sym x) api) -> [TypeSpec]

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

Match Symbol and :>.

Methods

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

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

Servant >= 0.5.0, pattern match on StdMethod and Headers.

Methods

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

HasGenericSpecs (Verb StdMethod method returnStatus contentTypes NoContent)

Servant >= 0.5.0, pattern match on StdMethod and NoContent.

Methods

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

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

Servant >= 0.5.0, pattern match on StdMethod and response with content.

Methods

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

http methods

combinators

data TypeSpec

Data type to for holding tests and type representation of each route in a Servant API. A function can be used to pick which tests to run and return the type name for reference.

Constructors

TypeSpec

Fields

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

class MkTypeSpecs a where

mkTypeSpecs has to be implemented as a method of a separate class, because we want to be able to have a specialized implementation for lists.

Minimal complete definition

mkTypeSpecs

Methods

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

Instances

MkTypeSpecs ()

We trust aeson to be correct for ().

Methods

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

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

Test JSON Serialization for non-wrapped types.

Methods

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

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

Test JSON serialization for '[]' types.

Methods

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

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

Test JSON serialization for Maybe types.

Methods

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