apiary-0.12.2: Simple and type safe web framework that can be automatically generate API documentation.

Safe HaskellNone

Control.Monad.Apiary

Contents

Synopsis

Documentation

data ApiaryT c n m a Source

most generic Apiary monad. since 0.8.0.0.

Instances

(Monad n, MonadBase b m) => MonadBase b (ApiaryT c n m) 
(Monad n, MonadBaseControl b m) => MonadBaseControl b (ApiaryT c n m) 
Monad n => MonadTrans (ApiaryT c n) 
Monad n => MonadTransControl (ApiaryT c n) 
Monad n => Monad (ApiaryT c n m) 
Functor (ApiaryT c n m) 
Monad n => Applicative (ApiaryT c n m) 
(Monad n, MonadIO m) => MonadIO (ApiaryT c n m) 

type Apiary c = ApiaryT c IO IdentitySource

no transformer. (ActionT IO, ApiaryT Identity)

runApiaryT :: (Monad n, Monad m) => (forall b. n b -> IO b) -> ApiaryConfig -> ApiaryT `[]` n m a -> m ApplicationSource

runApiaryT' :: (Monad n, Monad m) => (forall b. n b -> IO b) -> ApiaryConfig -> ApiaryT `[]` n m a -> m (Application, Documents)Source

getter

execute action

action :: Monad n => Fn c (ActionT n ()) -> ApiaryT c n m ()Source

splice ActionT ApiaryT.

action' :: Monad n => (SList c -> ActionT n ()) -> ApiaryT c n m ()Source

like action. but not apply arguments. since 0.8.0.0.

API documentation

group :: Text -> ApiaryT c n m a -> ApiaryT c n m aSource

API document group. since 0.12.0.0.

only top level group recognized.

document :: Text -> ApiaryT c n m a -> ApiaryT c n m aSource

add API document. since 0.12.0.0.

It use only filters prior document, so you should be placed document directly in front of action.

deprecated

actionWithPreAction :: Monad n => (SList xs -> ActionT n a) -> Fn xs (ActionT n ()) -> ApiaryT xs n m ()Source

Deprecated: use action'

execute action before main action. since 0.4.2.0