Servant.Hateoas.Resource

Resource

class HasResource ct

Class that indicates that a Content-Type has a specific Resource-Representation.

Associated Types

type Resource ct :: Type -> Type

Associated type for this Content-Type

Instances

HasResource (HAL t :: Type)

Defined in Servant.Hateoas.ContentType.HAL

Associated Types

type Resource (HAL t) :: Type -> Type

class HasResource ct => ToResource ct api a where

Class for converting values of a to their respective Resource-Representation.

Methods

toResource :: Proxy ct -> Proxy api -> a -> Resource ct a

Converts a value into it's Resource-Representation.

Instances

(Related a, HasField (IdSelName a) a id, IsElem (GetOneApi a) api, HasLink (GetOneApi a), MkLink (GetOneApi a) Link ~ (id -> Link), BuildRels api (Relations a) a, HasResource (HAL t)) => ToResource (HAL t :: Type) (api :: Type) a

Defined in Servant.Hateoas.ContentType.HAL

Methods

toResource :: Proxy (HAL t) -> Proxy api -> a -> Resource (HAL t) a

Hypermedia-Relations

Type

data HRel

Data-Kind for Hypermedia-Relations.

Constructors

HRel

Fields

• relName :: Symbol

  Name of the relation

• selName :: Symbol

  Record selectors field name

• endpoint :: Type

  Servant-Endpoint to use for retrieving one value for relation relName

Instances

BuildRels api ('[] :: [HRel]) a

Defined in Servant.Hateoas.Resource

Methods

buildRels :: Proxy '[] -> Proxy api -> a -> [(String, Link)]

(KnownSymbol relName, HasField selName a id, HasLink endpoint, IsElem endpoint api, MkLink endpoint Link ~ (id -> Link), BuildRels api rs a) => BuildRels api ('HRel relName selName endpoint ': rs) a

Defined in Servant.Hateoas.Resource

Methods

buildRels :: Proxy ('HRel relName selName endpoint ': rs) -> Proxy api -> a -> [(String, Link)]

Class

class Related a

Types that have Hypermedia-Relations.

Associated Types

type IdSelName a :: Symbol

Name of the record selector that holds the resources identifier

type GetOneApi a :: Type

Servant-Endpoint for retrieving one a by its identifier

type CollectionName a :: Symbol

Name for collected values

type CollectionName a = "items"

type Relations a :: [HRel]

List of all relations a has

Construction

class BuildRels api rs a where

Class for deriving Hypermedia-Relations for types.

Methods

buildRels :: Proxy rs -> Proxy api -> a -> [(String, Link)]

Instances

BuildRels api ('[] :: [HRel]) a

Defined in Servant.Hateoas.Resource

Methods

buildRels :: Proxy '[] -> Proxy api -> a -> [(String, Link)]

(KnownSymbol relName, HasField selName a id, HasLink endpoint, IsElem endpoint api, MkLink endpoint Link ~ (id -> Link), BuildRels api rs a) => BuildRels api ('HRel relName selName endpoint ': rs) a

Defined in Servant.Hateoas.Resource

Methods

buildRels :: Proxy ('HRel relName selName endpoint ': rs) -> Proxy api -> a -> [(String, Link)]

selfLink :: forall api a id. (Related a, HasField (IdSelName a) a id, IsElem (GetOneApi a) api, HasLink (GetOneApi a), MkLink (GetOneApi a) Link ~ (id -> Link)) => Proxy api -> a -> (String, Link)

Generates the pair ("self", link) where link is the Link to a itself.

relatedLinks :: forall api a. (Related a, BuildRels api (Relations a) a) => Proxy api -> a -> [(String, Link)]

Generates pairs (rel, link) for all related resources as defined with Relations.

defaultLinks :: forall api a id. (Related a, HasField (IdSelName a) a id, IsElem (GetOneApi a) api, HasLink (GetOneApi a), MkLink (GetOneApi a) Link ~ (id -> Link), BuildRels api (Relations a) a) => Proxy api -> a -> [(String, Link)]

Generate Hypermedia-Links by default.

defaultLinks api x = selfLink api x : relatedLinks api x