Hreq.Core.API.Internal

Specification for an API endpoint as a composition of Request and Response components at the Type level.

API type

data Api a

Constructors

Req [ReqContent a]

Res [ResContent a]

Instances

SingI content => SingI (Req content :: Api Type)

Defined in Hreq.Core.API.Internal

Methods

sing :: Sing (Req content)

SingI content => SingI (Res content :: Api Type)

Defined in Hreq.Core.API.Internal

Methods

sing :: Sing (Res content)

type Sing

Defined in Hreq.Core.API.Internal

type Sing = SApi

API GADT as a singleton.

data SApi (a :: Api Type)

Constructors

a ~ Req b => SReq (Sing b)

a ~ Res b => SRes (Sing b)

SingI instance for API types

API Type combinators

data (a :: k1) :> (b :: k2) infixr 7

type (:=) (a :: Symbol) (b :: k2) = '(a, b) infixr 1

For representing type level tuples where first value is a Symbol

>>> import Hreq.Core.API
>>> import GHC.Generics
>>> import Data.Aeson
>>> data User = User deriving (Show)
>>> instance ToJSON User where toJSON = undefined
>>> instance FromJSON User where parseJSON = undefined