Servant.Hateoas

Documentation

module Servant.Hateoas.Combinator.Title

data HAL (t :: Type)

Type representing Content-Types of Hypertext Application Language (HAL).

Type parameter t is the mime type suffix in application/hal+t.

Instances

Accept (HAL JSON)

Defined in Servant.Hateoas.ContentType.HAL

Methods

contentType :: Proxy (HAL JSON) -> MediaType

contentTypes :: Proxy (HAL JSON) -> NonEmpty MediaType

ToJSON (HALResource a) => MimeRender (HAL JSON) (HALResource a)

Defined in Servant.Hateoas.ContentType.HAL

Methods

mimeRender :: Proxy (HAL JSON) -> HALResource a -> ByteString

type MkResource (HAL t)

Defined in Servant.Hateoas.ContentType.HAL

type MkResource (HAL t) = HALResource

data HALResource a

HAL-resource representation.

Instances

Functor HALResource

Defined in Servant.Hateoas.ContentType.HAL

Methods

fmap :: (a -> b) -> HALResource a -> HALResource b

(<$) :: a -> HALResource b -> HALResource a

EmbeddingResource HALResource

Defined in Servant.Hateoas.ContentType.HAL

Methods

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

Resource HALResource

Defined in Servant.Hateoas.ContentType.HAL

Methods

wrap :: a -> HALResource a

addRel :: (String, RelationLink) -> HALResource a -> HALResource a

ToJSON (HALResource a) => MimeRender (HAL JSON) (HALResource a)

Defined in Servant.Hateoas.ContentType.HAL

Methods

mimeRender :: Proxy (HAL JSON) -> HALResource a -> ByteString

ToJSON a => ToJSON (HALResource [a])

Defined in Servant.Hateoas.ContentType.HAL

Methods

toJSON :: HALResource [a] -> Value

toEncoding :: HALResource [a] -> Encoding

toJSONList :: [HALResource [a]] -> Value

toEncodingList :: [HALResource [a]] -> Encoding

omitField :: HALResource [a] -> Bool

ToJSON a => ToJSON (HALResource a)

Defined in Servant.Hateoas.ContentType.HAL

Methods

toJSON :: HALResource a -> Value

toEncoding :: HALResource a -> Encoding

toJSONList :: [HALResource a] -> Value

toEncodingList :: [HALResource a] -> Encoding

omitField :: HALResource a -> Bool

Generic (HALResource a)

Defined in Servant.Hateoas.ContentType.HAL

Associated Types

type Rep (HALResource a) :: Type -> Type

Methods

from :: HALResource a -> Rep (HALResource a) x

to :: Rep (HALResource a) x -> HALResource a

type Rep (HALResource a)

Defined in Servant.Hateoas.ContentType.HAL

type Rep (HALResource a) = D1 ('MetaData "HALResource" "Servant.Hateoas.ContentType.HAL" "servant-hateoas-0.3.4-inplace" 'False) (C1 ('MetaCons "HALResource" 'PrefixI 'True) (S1 ('MetaSel ('Just "resource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a) :*: (S1 ('MetaSel ('Just "rels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(String, RelationLink)]) :*: S1 ('MetaSel ('Just "embedded") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(String, SomeF HALResource ToJSON)]))))

module Servant.Hateoas.ResourceServer

module Servant.Hateoas.RelationLink

module Servant.Hateoas.HasHandler

module Servant.Hateoas.Resource

module Servant.Hateoas.Layer