Servant.XML

Servant support for XML.

Types with a ToXml instance will be automatically marshalled into XML and successfully returned by Servant endpoints. Types with a FromXml instance can be decoded from request bodies.

In implementing these typeclass instances, you can use the primitives found in the xmlbf library.

Documentation

data XML

The application/xml Content-Type. To be used in Servant endpoints like:

data Foo = ...

instance ToXml Foo where
  toXml foo = ...

type API = ...
  :<|> "foo" :> Get '[XML] Foo
  :<|> "foo" :> "update" :> ReqBody '[XML] Foo :> PostAccepted '[JSON] ()

Instances

Accept XML

Defined in Servant.XML

Methods

contentType :: Proxy XML -> MediaType

contentTypes :: Proxy XML -> NonEmpty MediaType

ToXml a => MimeRender XML a

Defined in Servant.XML

Methods

mimeRender :: Proxy XML -> a -> ByteString

FromXml a => MimeUnrender XML a

Defined in Servant.XML

Methods

mimeUnrender :: Proxy XML -> ByteString -> Either String a

mimeUnrenderWithType :: Proxy XML -> MediaType -> ByteString -> Either String a