Safe Haskell	None
Language	Haskell2010

Control.Monad.Apiary

Contents

Runner
- Apiary -> Application
execute action
middleware
API documentation
not export from Web.Apiary

Synopsis

Documentation

data ApiaryT exts prms actM m a Source #

Apiary monad. since 0.8.0.0.

Instances

(Monad actM, MonadBase b m) => MonadBase b (ApiaryT exts prms actM m) Source #
Methods liftBase :: b α -> ApiaryT exts prms actM m α #
(Monad actM, MonadBaseControl b m) => MonadBaseControl b (ApiaryT exts prms actM m) Source #
Associated Types type StM (ApiaryT exts prms actM m :: * -> ) a :: # Methods liftBaseWith :: (RunInBase (ApiaryT exts prms actM m) b -> b a) -> ApiaryT exts prms actM m a # restoreM :: StM (ApiaryT exts prms actM m) a -> ApiaryT exts prms actM m a #
Monad actM => MonadExts exts (ApiaryT exts prms actM m) Source #
Methods getExts :: ApiaryT exts prms actM m (Extensions exts) Source #
Monad actM => MonadTrans (ApiaryT exts prms actM) Source #
Methods lift :: Monad m => m a -> ApiaryT exts prms actM m a #
Monad actM => MonadTransControl (ApiaryT exts prms actM) Source #
Associated Types type StT (ApiaryT exts prms actM :: (* -> ) -> -> ) a :: # Methods liftWith :: Monad m => (Run (ApiaryT exts prms actM) -> m a) -> ApiaryT exts prms actM m a # restoreT :: Monad m => m (StT (ApiaryT exts prms actM) a) -> ApiaryT exts prms actM m a #
Monad actM => Monad (ApiaryT exts prms actM m) Source #
Methods (>>=) :: ApiaryT exts prms actM m a -> (a -> ApiaryT exts prms actM m b) -> ApiaryT exts prms actM m b # (>>) :: ApiaryT exts prms actM m a -> ApiaryT exts prms actM m b -> ApiaryT exts prms actM m b # return :: a -> ApiaryT exts prms actM m a # fail :: String -> ApiaryT exts prms actM m a #
Functor (ApiaryT exts prms actM m) Source #
Methods fmap :: (a -> b) -> ApiaryT exts prms actM m a -> ApiaryT exts prms actM m b # (<$) :: a -> ApiaryT exts prms actM m b -> ApiaryT exts prms actM m a #
Monad actM => Applicative (ApiaryT exts prms actM m) Source #
Methods pure :: a -> ApiaryT exts prms actM m a # (<>) :: ApiaryT exts prms actM m (a -> b) -> ApiaryT exts prms actM m a -> ApiaryT exts prms actM m b # (>) :: ApiaryT exts prms actM m a -> ApiaryT exts prms actM m b -> ApiaryT exts prms actM m b # (<*) :: ApiaryT exts prms actM m a -> ApiaryT exts prms actM m b -> ApiaryT exts prms actM m a #
(Monad actM, MonadIO m) => MonadIO (ApiaryT exts prms actM m) Source #
Methods liftIO :: IO a -> ApiaryT exts prms actM m a #
type StT (ApiaryT exts prms actM) a Source #
type StT (ApiaryT exts prms actM) a
type StM (ApiaryT exts prms actM m) a Source #
type StM (ApiaryT exts prms actM m) a = ComposeSt (ApiaryT exts prms actM) m a

Runner

Apiary -> Application

runApiaryTWith :: (Monad actM, Monad m) => (forall b. actM b -> IO b) -> (Application -> m a) -> Initializer m '[] exts -> ApiaryConfig -> ApiaryT exts '[] actM m () -> m a Source #

run Apiary monad.

runApiaryWith :: Monad m => (Application -> m a) -> Initializer m '[] exts -> ApiaryConfig -> ApiaryT exts '[] IO m () -> m a Source #

runApiary :: Monad m => (Application -> m a) -> ApiaryConfig -> ApiaryT '[] '[] IO m () -> m a Source #

getApiaryTWith :: (Monad actM, Monad m) => (forall b. actM b -> IO b) -> Initializer m '[] exts -> ApiaryConfig -> ApiaryT exts '[] actM m () -> m Application Source #

get Application from Apiary monad. since 2.0.0.

getApiaryWith :: Monad m => Initializer m '[] exts -> ApiaryConfig -> ApiaryT exts '[] IO m () -> m Application Source #

getApiary :: Monad m => ApiaryConfig -> ApiaryT '[] '[] IO m () -> m Application Source #

data ApiaryConfig Source #

Constructors

ApiaryConfig

Fields

notFound :: Application
call when no handler matched.
defaultStatus :: Status
used unless call status function.
defaultHeaders :: ResponseHeaders
initial headers.
defaultContentType :: ByteString
failStatus :: Status
failHeaders :: ResponseHeaders
maxRequestSize :: Word64
maximum request size, default to 5MB. since 2.0.0.
uploadFilePath :: Maybe FilePath
where to store upload file. since 2.0.0.
default to Nothing, which saves file content in memory. NOTE. once you set this value to some path, it's your responsibility to clean uploaded files. eg. move or remove it.
rootPattern :: [Text]
used by root filter.
mimeType :: FilePath -> ByteString

Instances

Default ApiaryConfig Source #
Methods def :: ApiaryConfig #

execute action

action :: Monad actM => ActionT exts prms actM () -> ApiaryT exts prms actM m () Source #

splice ActionT to ApiaryT.

middleware

middleware :: Monad actM => Middleware -> ApiaryT exts prms actM m () Source #

add middleware.

please note that, this method just provide a shortcut to stack middleware. middlewares are added to whole Apiary application rather than specific route.

API documentation

group :: Text -> Filter' exts actM m Source #

API document group. since 0.12.0.0.

only top level group recognized.

document :: Text -> Filter' exts actM m Source #

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.

precondition :: Html -> Filter' exts actM m Source #

add user defined precondition. since 0.13.0.

noDoc :: Filter' exts actM m Source #

ignore next document.

not export from Web.Apiary

apiaryConfig :: Monad actM => ApiaryT exts prms actM m ApiaryConfig Source #

get Apiary configuration.

apiaryExt :: (Has e exts, Monad actM) => proxy e -> ApiaryT exts prms actM m e Source #

Deprecated: use getExt

get Apiary extension.