Payload.Spec

data Spec apiSpec

Wrapper for writing type-level specs

Constructors

• Spec

data Route (method :: Symbol) (path :: Symbol) spec

Type-level representation of an endpoint route, meant to be used in combination with the method convenience types.

Examples:

GET "/api/user/<id>"
DELETE "/api/posts/<..rest>"

Constructors

• Route

type GET = Route "GET"

type HEAD = Route "HEAD"

type POST = Route "POST"

type PUT = Route "PUT"

type DELETE = Route "DELETE"

data Routes (path :: Symbol) routesSpec

Defines a type-level parent route. Takes a path, which is prepended to all child routes, and a spec, which must be a type-level record. If the path contains named URL parameters, the types of those parameters must be given in the params field of the spec record. Can optionally contain a guards field with a list of guards to run before calling child routes. All other fields are treated as endpoint routes or sub-parent routes.

Example:

Routes "/users/<userId>" {
  guards :: Guards ("apiKey" : Nil),
  params :: { userId :: Int },
  posts :: GET "/posts" {
    response :: UserPosts
  }
}

Constructors

• Routes

data Guards (g :: GuardList)

Type-level list of guard names that will be run before calling a route or child routes.

Constructors

• Guards

data GuardList :: Type

data GNil :: GuardList

data GCons :: Symbol -> GuardList -> GuardList

Operator alias for Payload.Spec.GCons (right-associative / precedence 1)

type Nil = GNil