Network.YAML.API

Documentation

data Type

Data type description for API

Constructors

TVoid

Like (); YAML notation for it is Void.

TString

TText

TInteger

TDouble

TMaybe Type

Maybe Type. YAML notation is Maybe Type.

TList Type

[Type]. YAML notation is List Type.

TUser (Map Text Type)

User-defined record type

THaskell Text

Any Haskell type

Instances

Eq Type

Show Type

ToJSON Type

FromJSON Type

Lift Type

data Method

API method description

Constructors

Method

Fields

methodArgs :: [Type]

Types of method arguments

methodReturnType :: Type

Method return value type

Instances

Eq Method

Show Method

ToJSON Method

FromJSON Method

Lift Method

data API

API description

Constructors

API

Fields

apiUri :: Text

API service identification

apiTypes :: Map Text Type

Exposed data types

apiMethods :: Map Text Method

Exposed methods

Instances

Eq API

Show API

ToJSON API

FromJSON API

Lift API

readAPI :: FilePath -> ExpQ

Read API definition from file. Returned expression is of type API.