Servant.Hateoas.Resource

Resource

Construction

class ToResource api res a where

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

Minimal complete definition

toResource | toResource'

Methods

toResource :: a -> res a

Converts a value into it's Resource-Representation.

toResource' :: Proxy api -> Proxy res -> a -> res a

Like toResource but takes proxies for ambiguity.

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, Resource HALResource) => ToResource (api :: Type) HALResource a

Defined in Servant.Hateoas.ContentType.HAL

Methods

toResource :: a -> HALResource a

toResource' :: Proxy api -> Proxy HALResource -> a -> HALResource a

class ToCollection api res a where

Class for converting multiple values of a to their respective collection-like representation.

Minimal complete definition

toCollection | toCollection'

Methods

toCollection :: Foldable f => f a -> res a

Converts many values into their Collection-Representation.

toCollection' :: Foldable f => Proxy api -> Proxy res -> f a -> res a

Like toCollection but takes proxies for ambiguity.

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, Resource CollectionResource) => ToCollection (api :: Type) CollectionResource a

Defined in Servant.Hateoas.ContentType.Collection

Methods

toCollection :: Foldable f => f a -> CollectionResource a

toCollection' :: Foldable f => Proxy api -> Proxy CollectionResource -> f a -> CollectionResource a

Modification

class Resource res where

Class for resources that carry Hypermedia-Relations.

Methods

addLink :: (String, Link) -> res a -> res a

Add a relation (rel, link) to a resource.

Instances

Resource CollectionItem

Defined in Servant.Hateoas.ContentType.Collection

Methods

addLink :: forall (a :: k). (String, Link) -> CollectionItem a -> CollectionItem a

Resource CollectionResource

Defined in Servant.Hateoas.ContentType.Collection

Methods

addLink :: forall (a :: k). (String, Link) -> CollectionResource a -> CollectionResource a

Resource HALResource

Defined in Servant.Hateoas.ContentType.HAL

Methods

addLink :: forall (a :: k). (String, Link) -> HALResource a -> HALResource a

class Resource res => EmbeddingResource res where

Class for Resources that can embed other resources.

Methods

embed :: ToJSON e => (String, e) -> res a -> res a

Embed a resource b with its relation rel as tuple (rel, b).

Instances

EmbeddingResource HALResource

Defined in Servant.Hateoas.ContentType.HAL

Methods

embed :: forall e (a :: k). ToJSON e => (String, e) -> HALResource a -> HALResource a

class Resource res => CollectingResource res where

Class for Resources that can collect multiple resources.

Methods

collect :: a -> res a -> res a

Collect a resource into the collection.

Instances

CollectingResource CollectionResource

Defined in Servant.Hateoas.ContentType.Collection

Methods

collect :: a -> CollectionResource a -> CollectionResource 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