Documentation

RecordParam uses the fields in the record to represent the parameters. The name of the field is used as parameter name, and the type is the return type. For example, this api:

type API = "users" :> (QueryParam "category" Category :>
                       QueryParam' '[Required, Strict] "sort_by" SortBy :>
                       QueryFlag "with_schema" :>
                       QueryParams "filters" Filter :>
                       Get '[JSON] User

can be written with records:

data UserParams = UserParams
  { category :: Maybe Category
  , sort_by :: Sortby
  , with_schema :: Bool
  , filters :: [Filter]
  }

type API = "users" :> RecordParam UserParams :> Get '[JSON] User

Type family to rewrite a RecordParam Api to a regular servant API. Useful to define instances for classes that extract information from the API type, such as Servant.Swagger, or servant-foreign.

Typical use:

instance SomeClass (UnRecordParam (RecordParam a :> api))) =>
         SomeClass (RecordParam a :> api) where
   someMethod _ =
     someMethod (Proxy :: Proxy (UnRecordParam (RecordParam a :> api))